Поделиться через


Морта (предварительная версия)

API Morta основан на REST. Наш API принимает органы запроса в кодировке JSON и возвращает кодированные респонсы JSON. Мы используем стандартные HTTP-ответы, проверку подлинности и команды. Все запросы API должны иметь заголовок авторизации формы: { Authorization: 'Bearer <API_KEY>' }

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
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)
Контакт
Имя Поддержка Mort
URL https://morta.io
Адрес электронной почты support@morta.io
Метаданные соединителя
Publisher Морта
Веб-сайт https://morta.io
Политика конфиденциальности https://morta.io/termsofservice
Категории Продуктивность; Содержимое и файлы

Morta предлагает облачное решение, которое глубоко интегрируется с программным обеспечением, к которому вы привыкли, предоставляя возможность оцифровывать, подключаться и автоматизировать процессы отслеживания. Соединитель Morta позволяет взаимодействовать со всеми функциями Morta через платформу Microsoft Power Automate.

Предпосылки

Для использования этого соединителя потребуется учетная запись Morta

Получение учетных данных

Войдите в учетную запись Morta , перейдите к интеграции Morta и просто добавьте новый ключ API. Затем этот ключ API можно использовать в Microsoft Power Automate. При вводе ключа API на платформу Microsoft Power Automate убедитесь, что вы указали "Носитель", чтобы введенный ключ API выглядел следующим образом: "Медведь YOUR_API_KEY_HERE".

Начало работы с соединителем

Чтобы приступить к работе с соединителем, можно начать с извлечения любимых проектов или рабочих областей с платформы Morta. Для этого можно использовать действие GetFavouriteProjects.

После этого можно создать процесс или документ в Morta с помощью действия CreateProcess и следующих параметров:

  • имя: новый процесс
  • идентификатор проекта: <one_of_your_project_public_ids>
  • тип: custom

Известные проблемы и ограничения

None

Распространенные ошибки и средства устранения неполадок

При использовании соединителя Morta может возникнуть один из следующих кодов состояния HTTP:

  • 401: действие запроса не авторизовано. Это может быть связано с тем, что вы не ввели ключ API или неправильно ввели ключ API (например, не добавьте "Медведь" до скопированного ключа API)
  • 403. У вас нет доступа к запрошенным ресурсу Morta. Обязательно запрашивайте разрешения на запрошенный ресурс от владельца этого ресурса.
  • 404: ресурс Morta не существует. Войдите на платформу Morta, чтобы убедиться, что вы правильно ввели идентификатор.
  • 422. Данные отсутствуют или форматируются неправильно в запросе. Убедитесь, что вы прочитали описание всех данных, необходимых в запросе, и выполнили спецификацию. Например, вам может потребоваться ввести число в качестве поля, но вместо этого ввели строку.
  • 429: Слишком много запросов было отправлено в Морту за период времени. Убедитесь, что вы не отправляете более 10 запросов в секунду на платформу Morta.

Часто задаваемые вопросы

Вопрос. Почему ключ API Morta не работает? Ответ. Убедитесь, что вы добавили "Носителя" в начало ключа API (слово "Медведь" и пробел). Окончательный ключ API, введенный, должен иметь следующий вид (фиктивный ключ API используется здесь): "Bearer zSujSa_eXxd3b1yVtTQVMw7Ghn18Ja9sOWvj-O4C908"

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для подключения MotaWord True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Восстановление проекта

Восстановление определенного проекта, определяемого его идентификатором UUID, которое было удалено ранее

Восстановление столбца таблицы

Восстановите ранее удаленный столбец в таблице.

Восстановление удаленной таблицы

Восстановите ранее удаленную таблицу с помощью UUID.

Добавление или обновление строк в таблице

Строки Upsert (добавление или обновление) в представлении таблицы на основе указанного столбца.

Добавление столбца в представление

Добавьте новый столбец в определенное представление таблицы.

Добавление строк в конец таблицы

Вставьте новые строки в конце указанного представления таблицы.

Добавление строки в таблицу

Добавьте новую строку в указанную таблицу.

Добавление тега пользователю

Добавление тега конкретному пользователю

Дублирование представления по умолчанию для таблицы

Создайте дубликат представления по умолчанию для определенной таблицы.

Дублирование представления таблицы

Создайте дубликат существующего представления для определенной таблицы.

Дублирование проекта

Создание дубликата существующего проекта

Дублирование процесса

Дублирование существующего процесса, потенциально в другом проекте

Дублирование таблицы

Создайте дубликат существующей таблицы вместе с данными, параметрами и необязательными связанными таблицами.

Запрос разрешений для ресурса

Запрос разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Изменение роли пользователя в проекте

Изменение роли пользователя в определенном проекте, определяемого идентификатором UUID проекта и идентификатором Firebase пользователя.

Обновление ключа API

Обновление ключа API для пользователя, вошедшего в систему

Обновление нескольких разделов процессов

Обновите несколько существующих разделов процесса.

Обновление одного уведомления

Обновите определенное уведомление по его идентификатору.

Обновление представления таблицы

Обновите существующее представление для определенной таблицы.

Обновление приглашения проекта

Обновление существующего приглашения в проекте

Обновление примечания

Обновление определенного комментария в потоке комментариев

Обновление разрешений для ресурса

Обновление разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Обновление секрета проекта

Обновление определенного секрета в проекте

Обновление соединения таблицы

Обновите существующее соединение в таблице.

Обновление стиля заголовка проекта

Обновление стиля заголовка для определенного проекта

Обновление столбца в представлении

Обновите определенный столбец в представлении таблицы.

Обновление столбца таблицы

Обновите свойства определенного столбца в таблице.

Обновление существующего ответа процесса

Обновите существующий ответ для раздела процесса.

Обновление существующего проекта

Обновление сведений о существующем проекте по идентификатору проекта

Обновление существующего процесса

Обновление сведений о существующем процессе по идентификатору процесса

Обновление существующего раздела процесса

Обновление сведений о существующем разделе процесса по идентификатору раздела процесса

Обновление существующей таблицы

Обновите свойства существующей таблицы.

Обновление существующих строк

Обновите существующие строки в указанном представлении таблицы.

Обновление существующих строк в таблице

Обновите существующие строки в указанной таблице.

Обновление существующих ячеек таблицы

Обновите определенные ячейки в представлении таблицы.

Обновление текущего профиля пользователя

Обновление профиля текущего пользователя, вошедшего в систему

Обновление учетной записи пользователя

Обновление сведений об учетной записи для пользователя, вошедшего в систему

Обновление ячеек таблицы

Обновите определенные ячейки в таблице.

Ответ процесса восстановления

Восстановите ранее удаленный ответ процесса.

Отправка ответа процесса

Отправьте ответ процесса, помечая его как завершенное.

Отправка черновика ответа процесса

Отправьте черновик ответа процесса для последующего завершения.

Переключение избранного состояния проекта

Изменение того, является ли проект фаворитом для пользователя, вошедшего в систему.

Переключение состояния закреплений проекта

Изменение того, закреплен ли проект для пользователя, вошедшего в систему

Повторная отправка приглашения пользователю для проекта

Повторно отправьте приглашение пользователю для проекта. Это применимо как для новых пользователей, так и для существующих пользователей, которые ранее были приглашены. Требуется разрешение владельца или администратора.

Повторное открытие потока комментариев

Повторно откройте ранее разрешенный поток комментариев

Повторяющийся процесс

Дублирование существующего процесса при необходимости в другой проект

Поиск в проекте

Выполнение операции поиска в определенном проекте, определяемой его UUID

Поиск пользователей

Поиск пользователей по проекту или процессу

Получение вкладов пользователей

Получение количества вкладов в день, сделанных пользователем, идентифицируемым идентификатором Firebase

Получение всех представлений для таблицы

Получение всех представлений, связанных с определенной таблицей.

Получение всех событий для ресурса

Извлеките все события, связанные с определенным ресурсом, отфильтрованные по различным критериям.

Получение всех соединений таблиц

Извлеките все соединения, связанные с таблицей.

Получение данных диаграммы для представления

Получение данных для создания диаграммы на основе определенного представления таблицы.

Получение достижений пользователей

Получение значков достижения пользователя по идентификатору Firebase

Получение закрепленных проектов пользователя

Получение проектов, закрепленных пользователем по идентификатору Firebase

Получение любимых проектов пользователя

Получение всех любимых проектов, вошедшего в систему пользователя, является частью

Получение общедоступных вкладов пользователей

Получение общедоступных вкладов, внесенных пользователем, идентифицируемых идентификатором Firebase

Получение общедоступных проектов пользователя

Получение всех общедоступных проектов, в которых пользователь является членом

Получение одного представления для таблицы

Получите определенное представление по идентификатору таблицы.

Получение отправленных уведомлений для проекта

Получение всех отправленных уведомлений для указанного проекта

Получение переменных проекта

Получение всех переменных, связанных с указанным проектом

Получение пользовательских проектов

Получение всех проектов, вошедшего в систему пользователя, является частью

Получение пользовательских шаблонов

Получение всех шаблонов, к пользователям, вошедшего в систему, имеет доступ к

Получение потока комментариев

Получение определенного потока комментариев по идентификатору

Получение потоков комментариев по ссылке

Получение всех потоков комментариев, связанных с определенной ссылкой

Получение приглашенных участников проекта

Получение всех приглашенных участников для указанного проекта

Получение процессов в проекте

Получение всех процессов, связанных с определенным проектом, идентифицируемым его UUID

Получение раздела "Процесс"

Получение определенного раздела процесса.

Получение разделов удаленного процесса

Получение всех удаленных разделов определенного процесса с необязательным фильтром для определенного раздела процесса

Получение разрешений на ресурсы

Получение разрешений для указанного ресурса, например таблицы, представления таблицы или процесса.

Получение ресурсов проекта

Получение ресурсов, связанных с определенным проектом, определяемым его UUID

Получение сведений

Получение сведений о текущем пользователе

Получение сведений о конкретном пользователе

Получение сведений о конкретном пользователе

Получение сведений о пользователе по общедоступному идентификатору

Получение сведений о конкретном пользователе по их общедоступному идентификатору

Получение сведений о проекте

Получение подробных сведений о конкретном проекте, определяемом его UUID

Получение сведений о процессе

Получение подробных сведений о конкретном процессе с помощью UUID

Получение секретов проекта

Получение всех секретов для указанного проекта

Получение списка всех поддерживаемых типов событий

Получите список всех поддерживаемых типов событий для уведомлений.

Получение статистики по столбцам таблицы

Получение статистических данных для столбцов в определенном представлении таблицы.

Получение статистики потока комментариев

Получение статистики для потоков комментариев на основе ссылочного типа и основного идентификатора ссылки

Получение статистики столбцов таблицы

Получение статистики для столбцов таблиц на основе указанных параметров.

Получение столбцов таблицы

Извлеките все активные столбцы определенной таблицы.

Получение строк таблицы

Извлеките строки из таблицы на основе предоставленных параметров запроса.

Получение таблиц и его строк

Получение таблицы и строк на основе предоставленных параметров

Получение таблиц проекта

Получение таблиц, связанных с определенным проектом, идентифицируемым его UUID

Получение тега по общедоступному идентификатору

Получение тега по его общедоступному идентификатору.

Получение тегов проекта

Получение всех тегов, связанных с указанным проектом

Получение уведомлений для проекта

Извлеките все уведомления, связанные с определенным проектом. Эта конечная точка доступна только пользователям с разрешениями уровня владельца для проекта.

Получение удаленных процессов в проекте

Получение всех удаленных процессов, связанных с определенным проектом, идентифицируемым его UUID

Получение удаленных таблиц в проекте

Извлеките все удаленные таблицы из определенного проекта, определяемого его UUID. Доступны только владельцы проектов.

Получение уникальных значений для столбца

Получение уникальных или уникальных значений для определенного столбца в представлении таблицы.

Получение уникальных значений для столбца

Получение списка уникальных (уникальных) значений для указанного столбца в таблице.

Получение управляемых и администрирование проектов пользователей

Получение всех проектов, в которых пользователь является владельцем или администратором

Получение файла для ячейки таблицы

Получение файла, связанного с определенной ячейкой в таблице.

Получение фактических данных представления таблицы

Получение фактических данных для определенного представления таблицы.

Получение членов проекта

Получение всех элементов, связанных с указанным проектом

Порядок раздела обновления

Обновите порядок разделов процесса в процессе.

Потоковая передача всех строк для представления

Потоковая передача данных всех строк для определенного представления таблицы.

Потоковая передача всех строк для таблицы

Потоковая передача данных всех строк для определенной таблицы.

Предварительная версия результирующей строки из входных данных

Просмотр результирующей строки из заданных входных данных в определенном представлении таблицы.

Приглашение нескольких пользователей в проект

Пригласите нескольких пользователей присоединиться к проекту по электронной почте. Если пользователи уже существуют, они добавляются напрямую, в противном случае отправляется приглашение. Требуется разрешение владельца или администратора.

Приглашение пользователя в проект

Пригласите одного пользователя присоединиться к проекту по электронной почте. Если пользователь уже существует, они добавляются напрямую; в противном случае отправляется приглашение. Требуется разрешение владельца или администратора.

Проверка столбца представлений используется в

Извлеките все представления, в которых используется определенный столбец таблицы.

Проверка таблицы процессов используется в

Проверьте и возвратите список процессов, соединений таблиц и выбирает место использования указанной таблицы.

Процесс восстановления

Восстановление удаленного процесса, определяемого его UUID

Процесс удаления

Удаление процесса, определяемого его идентификатором UUID

Процесс экспорта

Экспорт определенного процесса с помощью UUID в различные форматы (PDF или DOCX)

Раздел "Повторяющийся процесс"

Дублирование определенного раздела процесса.

Раздел "Повторяющийся процесс"

Повторяйте определенный раздел процесса асинхронно.

Раздел процесса восстановления

Восстановите ранее удаленный раздел процесса.

Разрешение потока комментариев

Разрешение потока комментариев

Сброс ответа процесса

Сброс существующего ответа процесса на исходное состояние.

Синхронизация таблицы с интеграцией

Синхронизация таблицы с указанной интеграцией.

Скачивание данных в виде CSV-файла

Скачайте данные определенного представления таблицы в формате CSV.

Скачивание данных таблицы в формате CSV

Скачайте данные указанной таблицы в виде CSV-файла.

Скачивание изображения диаграммы

Скачайте файл изображения диаграммы на основе данных из определенного представления таблицы.

Создание запроса на скачивание сквозного руководства

Вызов API сквозного руководства к внешней исходной системе для скачивания файлов.

Создание индекса в столбце таблицы

Создайте индекс для одной или нескольких столбцов таблицы для повышения производительности запросов.

Создание ключа API для пользователя

Создание ключа API для пользователя, вошедшего в систему.

Создание комментария

Создание комментария в определенном потоке комментариев

Создание нескольких разделов процесса

Создание нескольких новых разделов в рамках указанного процесса с дополнительным родительским разделом

Создание нового пользователя

Создание нового пользователя

Создание нового представления для таблицы

Создайте новое представление для определенной таблицы.

Создание нового процесса

Создание нового процесса в указанном проекте

Создание ответа на новый процесс

Создайте новый ответ для раздела процесса.

Создание потока комментариев

Создание потока комментариев

Создание проекта

Создание проекта с указанным именем

Создание раздела "Создание процесса"

Создание нового раздела в рамках указанного процесса с возможностью задания родительского раздела

Создание разделов процесса

Создание нескольких разделов в процессе

Создание разрешений для ресурса

Создание разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Создание секрета проекта

Создание нового секрета для указанного проекта

Создание сквозного запроса к исходной системе

Вызов API сквозного руководства к внешней исходной системе.

Создание соединения таблицы

Создайте соединение между двумя таблицами.

Создание стиля заголовка проекта

Создание стиля заголовка для определенного проекта

Создание столбца таблицы

Добавьте новый столбец в существующую таблицу.

Создание таблицы документов

Создайте новую таблицу документов в проекте.

Создание уведомления

Создайте новое уведомление для определенного проекта.

Средства реагирования на процессы обновления

Обновление списка респондентов для заданного процесса, определяемого его UUID

Строка Upsert в таблице

Добавьте или обновите строку в указанной таблице на основе уникального значения столбца.

Удаление всех строк из таблицы

Удаляет все строки из указанной таблицы.

Удаление интеграции из таблицы

Удалите определенную интеграцию из таблицы.

Удаление ключа API

Удаление ключа API для пользователя, вошедшего в систему

Удаление комментария

Удаление определенного комментария в потоке комментариев

Удаление одного уведомления

Удалите определенное уведомление по его идентификатору.

Удаление определенных строк

Удаление определенных строк из представления таблицы на основе идентификаторов строк.

Удаление ответа процесса

Удаление определенного ответа процесса.

Удаление пользователя из проекта

Удаление пользователя из определенного проекта, определяемого идентификатором UUID проекта и идентификатором Пользователя Firebase

Удаление потока комментариев

Удаление потока комментариев

Удаление представления таблицы

Удаление определенного представления таблицы.

Удаление приглашения проекта

Удаление приглашения в проект

Удаление проекта

Удаление определенного проекта, определяемого его UUID

Удаление раздела "Процесс"

Удаление определенного раздела процесса.

Удаление разрешений для ресурса

Удаление разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Удаление секрета проекта

Удаление определенного секрета из проекта

Удаление соединения таблицы

Удаление соединения из таблицы.

Удаление стиля заголовка верхнего проекта

Удаление стиля верхнего заголовка для определенного проекта

Удаление столбца таблицы

Удалите определенный столбец из таблицы.

Удаление строк таблицы

Удалите все строки или определенные строки из таблицы.

Удаление тега из пользователя

Удаление тега из определенного пользователя

Удалить таблицу

Удалите указанную таблицу по идентификатору UUID.

Установка представления в качестве представления по умолчанию

Указать определенное представление таблицы в качестве представления по умолчанию для таблицы.

Восстановление проекта

Восстановление определенного проекта, определяемого его идентификатором UUID, которое было удалено ранее

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, который необходимо восстановить

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Восстановление столбца таблицы

Восстановите ранее удаленный столбец в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей столбец для восстановления

Идентификатор столбца
column_id True uuid

UUID столбца для восстановления

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableColumn
metadata
metadata object

Восстановление удаленной таблицы

Восстановите ранее удаленную таблицу с помощью UUID.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для восстановления

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
metadata
metadata object

Добавление или обновление строк в таблице

Строки Upsert (добавление или обновление) в представлении таблицы на основе указанного столбца.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, в котором должны быть добавлены строки.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowData
rowData True object
sortOrder
sortOrder number
upsertColumnName
upsertColumnName True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Добавление столбца в представление

Добавьте новый столбец в определенное представление таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, к которому добавляется столбец.

aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
hardValidation
hardValidation boolean
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
locked
locked True boolean
mortaSynced
mortaSynced integer
имя
name True string
procoreSynced
procoreSynced integer
publicId
publicId uuid
required
required True boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
sortOrder
sortOrder True number
stringValidation
stringValidation string
thousandSeparator
thousandSeparator boolean
validationMessage
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNoDuplicates
validationNoDuplicates boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableViewColumn
metadata
metadata object

Добавление строк в конец таблицы

Вставьте новые строки в конце указанного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, в котором добавляются строки.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowData
rowData True object
sortOrder
sortOrder number

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Добавление строки в таблицу

Добавьте новую строку в указанную таблицу.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, в которую будет добавлена строка

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowData
rowData True object
sortOrder
sortOrder number

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Добавление тега пользователю

Добавление тега конкретному пользователю

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
user_id True uuid

Общедоступный идентификатор UUID пользователя для добавления тега в

tagReferenceId
tagReferenceId True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Tag
metadata
metadata object

Дополнительные метаданные

Дублирование представления по умолчанию для таблицы

Создайте дубликат представления по умолчанию для определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы, для которой должно быть дублировано представление по умолчанию.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
имя
name string
type
type integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableView
metadata
metadata object

Дублирование представления таблицы

Создайте дубликат существующего представления для определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы, для которой должно быть дублировано представление.

Идентификатор представления
view_id True uuid

Идентификатор UUID представления, который необходимо дублировать.

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableView
metadata
metadata object

Дублирование проекта

Создание дубликата существующего проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, который будет дублироваться

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
дубликатыPermissions
duplicatePermissions boolean

Дублирование процесса

Дублирование существующего процесса, потенциально в другом проекте

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса, который будет дублироваться

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
дубликатыLinkedTables
duplicateLinkedTables boolean
дубликатыPermissions
duplicatePermissions boolean
targetProjectId
targetProjectId string

Дублирование таблицы

Создайте дубликат существующей таблицы вместе с данными, параметрами и необязательными связанными таблицами.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, повторяемой

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
дубликатыLinkedTables
duplicateLinkedTables boolean
дубликатыPermissions
duplicatePermissions boolean
targetProjectId
targetProjectId string

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Запрос разрешений для ресурса

Запрос разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, к которому принадлежит ресурс.

Тип
type True string

Тип ресурса, для которого требуется запрашивать разрешения. Допустимые параметры: project, process, table или view.

Идентификатор
id True uuid

UUID ресурса, для которого требуется запрашивать разрешения.

Изменение роли пользователя в проекте

Изменение роли пользователя в определенном проекте, определяемого идентификатором UUID проекта и идентификатором Firebase пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта

Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, роль которого должна быть изменена

роль
role True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Обновление ключа API

Обновление ключа API для пользователя, вошедшего в систему

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ключа API
api_key_id True uuid

Идентификатор UUID ключа API для обновления

имя
name string

Возвращаемое значение

Имя Путь Тип Описание
apiKey
apiKey string

Обновленные сведения о ключе API

Обновление нескольких разделов процессов

Обновите несколько существующих разделов процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
имя
name string
pageBreakBefore
pageBreakBefore boolean
pdfIncludeDescription
pdfIncludeDescription boolean
pdfIncludeSection
pdfIncludeSection boolean
plaintextDescription
plaintextDescription string
publicId
publicId True uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of MortaProcessSection
metadata
metadata object

Обновление одного уведомления

Обновите определенное уведомление по его идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True uuid

Идентификатор UUID уведомления, который необходимо обновить.

описание
description string
processes
processes array of uuid
tables
tables array of uuid
publicId
publicId uuid
resource
resource True string
глагол
verb True string
webhookUrl
webhookUrl True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Notification
metadata
metadata object

Обновление представления таблицы

Обновите существующее представление для определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, который необходимо обновить.

allowContributorDelete
allowContributorDelete boolean
chartSettings
chartSettings
свернутыйGroupView
collapsedGroupView boolean
backgroundColour
backgroundColour True string
columnId
columnId uuid
columnName
columnName True string
Тип фильтра
filterType True string
fontColour
fontColour True string
multipleValues
multipleValues array of
value
value
aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
hardValidation
hardValidation boolean
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
locked
locked boolean
mortaSynced
mortaSynced integer
имя
name string
procoreSynced
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
sortOrder
sortOrder number
stringValidation
stringValidation string
thousandSeparator
thousandSeparator boolean
validationMessage
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNoDuplicates
validationNoDuplicates boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
disableNewRow
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
columnId
columnId uuid
columnName
columnName True string
Тип фильтра
filterType True string
multipleValues
multipleValues array of
orGroup
orGroup string
value
value
frozenIndex
frozenIndex integer
columnId
columnId uuid
columnName
columnName True string
направление
direction True string
имя
name string
rowHeight
rowHeight integer
columnId
columnId uuid
columnName
columnName True string
направление
direction True string
type
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableView
metadata
metadata object

Обновление приглашения проекта

Обновление существующего приглашения в проекте

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, в котором находится приглашение

Идентификатор приглашения
invite_id True uuid

Идентификатор UUID приглашения, который будет обновлен

tags
tags array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data InvitedMember
metadata
metadata object

Обновление примечания

Обновление определенного комментария в потоке комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев, содержащего комментарий

Идентификатор комментария
comment_id True uuid

Идентификатор UUID обновленного комментария

commentText
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data Comment
change
metadata.change object

Изменения, внесенные в комментарий

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID обновленного комментария

Обновление разрешений для ресурса

Обновление разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True uuid

Идентификатор UUID политики для обновления.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
роль
role True integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data AccessPolicy
metadata
metadata object

Обновление секрета проекта

Обновление определенного секрета в проекте

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, в котором находится секрет.

Идентификатор секрета
secret_id True uuid

Идентификатор UUID секрета, который необходимо обновить

имя
name True string
value
value True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data ProjectSecret
metadata
metadata object

Обновление соединения таблицы

Обновите существующее соединение в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы с обновлением соединения.

Идентификатор соединения
join_id True uuid

Идентификатор UUID обновляемого соединения.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dataColumns
dataColumns array of string
isOneToMany
isOneToMany boolean
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
joinViewId
joinViewId string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
metadata
metadata object

Обновление стиля заголовка проекта

Обновление стиля заголовка для определенного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого необходимо обновить стили заголовка

Идентификатор стиля
style_id True uuid

Идентификатор UUID стиля, который необходимо обновить

bold
bold boolean
цвет
colour string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
fontSize
fontSize number
курсив
italic boolean
нумерующий стиль
numberingStyle integer
startAt0
startAt0 boolean
подчеркнутый
underline boolean

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Обновление столбца в представлении

Обновите определенный столбец в представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, содержащего обновляемый столбец.

Идентификатор столбца
column_id True uuid

Идентификатор UUID столбца в представлении таблицы, который необходимо обновить.

aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
hardValidation
hardValidation boolean
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
locked
locked boolean
mortaSynced
mortaSynced integer
имя
name string
procoreSynced
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
sortOrder
sortOrder number
stringValidation
stringValidation string
thousandSeparator
thousandSeparator boolean
validationMessage
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNoDuplicates
validationNoDuplicates boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableViewColumn
metadata
metadata object

Обновление столбца таблицы

Обновите свойства определенного столбца в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей столбец

Идентификатор столбца
column_id True uuid

Идентификатор UUID столбца для обновления

aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
isIndexed
isIndexed boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
mortaSynced
mortaSynced integer
имя
name True string
procoreSynced
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
thousandSeparator
thousandSeparator boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableColumn
metadata
metadata object

Обновление существующего ответа процесса

Обновите существующий ответ для раздела процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID ответа процесса, который необходимо обновить.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dueDate
dueDate date-time
expireResponse
expireResponse boolean
pdfIncludeResponse
pdfIncludeResponse boolean
resetAfterResponse
resetAfterResponse boolean
Реагирования
responders array of string
type
type string
typeOptions
typeOptions

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessResponse
metadata
metadata object

Обновление существующего проекта

Обновление сведений о существующем проекте по идентификатору проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта для обновления

defaultProcessId
defaultProcessId uuid
hideProcessCreated
hideProcessCreated boolean
logo
logo string
mfaRequired
mfaRequired boolean
имя
name string
primaryColour
primaryColour string
processTitleBold
processTitleBold boolean
processTitleColour
processTitleColour string
processTitleFontSize
processTitleFontSize number
processTitleItalic
processTitleItalic boolean
processTitleUnderline
processTitleUnderline boolean
общественный
public boolean

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Обновление существующего процесса

Обновление сведений о существующем процессе по идентификатору процесса

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для обновления

allowComments
allowComments boolean
allowDuplication
allowDuplication boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
expandByDefault
expandByDefault boolean
isTemplate
isTemplate boolean
logo
logo string
имя
name string
plaintextDescription
plaintextDescription string
templateCategory
templateCategory string
type
type string
variables
variables array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProcess
metadata
metadata object

Обновление существующего раздела процесса

Обновление сведений о существующем разделе процесса по идентификатору раздела процесса

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса для обновления.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
имя
name string
pageBreakBefore
pageBreakBefore boolean
pdfIncludeDescription
pdfIncludeDescription boolean
pdfIncludeSection
pdfIncludeSection boolean
plaintextDescription
plaintextDescription string

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Обновление существующей таблицы

Обновите свойства существующей таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы для обновления

allowDuplication
allowDuplication boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
isOneToMany
isOneToMany boolean
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
joinTableName
joinTableName string
joinViewId
joinViewId string
joinViewName
joinViewName string
publicId
publicId uuid
keepColoursInSync
keepColoursInSync boolean
keepValidationsInSync
keepValidationsInSync boolean
logo
logo string
имя
name string
syncHourlyFrequency
syncHourlyFrequency integer
type
type string
variables
variables array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
metadata
metadata object

Обновление существующих строк

Обновите существующие строки в указанном представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, в котором должны быть обновлены строки.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
publicId
publicId True uuid
rowData
rowData True object
sortOrder
sortOrder number

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Обновление существующих строк в таблице

Обновите существующие строки в указанной таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, в которой будут обновлены строки

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
publicId
publicId True uuid
rowData
rowData True object
sortOrder
sortOrder number

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Обновление существующих ячеек таблицы

Обновите определенные ячейки в представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, в котором нужно обновить ячейки.

columnName
columnName True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowId
rowId True string
value
value
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Обновление текущего профиля пользователя

Обновление профиля текущего пользователя, вошедшего в систему

Параметры

Имя Ключ Обязательно Тип Описание
био
bio string
linkedin
linkedin string
location
location string
имя
name string
организация
organisation string
profilePicture
profilePicture string
подпись
signature string
твиттер
twitter string
университет
university string
universityDegree
universityDegree string
веб-сайт
website string

Возвращаемое значение

Имя Путь Тип Описание
данные
data User
metadata
metadata object

Обновление учетной записи пользователя

Обновление сведений об учетной записи для пользователя, вошедшего в систему

Параметры

Имя Ключ Обязательно Тип Описание
oldPassword
oldPassword True string
пароль
password True string
passwordConfirm
passwordConfirm True string
twoFactorCode
twoFactorCode string

Возвращаемое значение

Имя Путь Тип Описание
данные
data UserWithToken
metadata
metadata object

Обновление ячеек таблицы

Обновите определенные ячейки в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей ячейки, которые необходимо обновить.

columnName
columnName True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowId
rowId True string
value
value
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Ответ процесса восстановления

Восстановите ранее удаленный ответ процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID ответа процесса, который необходимо восстановить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data ProcessResponse
metadata
metadata object

Отправка ответа процесса

Отправьте ответ процесса, помечая его как завершенное.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID отправленного ответа процесса.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
response
response

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Отправка черновика ответа процесса

Отправьте черновик ответа процесса для последующего завершения.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID ответа процесса для отправки в виде черновика.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
response
response

Возвращаемое значение

Имя Путь Тип Описание
данные
data ProcessSection
metadata
metadata object

Переключение избранного состояния проекта

Изменение того, является ли проект фаворитом для пользователя, вошедшего в систему.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Общедоступный идентификатор проекта для переключения избранного состояния

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
isDeleted
data.isDeleted boolean

Указывает, удаляется ли проект

имя
data.name string

Имя проекта

projectRole
data.projectRole string

Роль пользователя в проекте

publicId
data.publicId uuid

Общедоступный идентификатор проекта

metadata
metadata object

Дополнительные метаданные

Переключение состояния закреплений проекта

Изменение того, закреплен ли проект для пользователя, вошедшего в систему

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Общедоступный идентификатор проекта для переключения состояния закрепления

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
Участников
data.contributors integer

Число участников проекта

имя
data.name string

Имя проекта

primaryColour
data.primaryColour string

Основной цвет проекта

publicId
data.publicId uuid

Общедоступный идентификатор проекта

views
data.views integer

Количество представлений проекта

metadata
metadata object

Дополнительные метаданные

Повторная отправка приглашения пользователю для проекта

Повторно отправьте приглашение пользователю для проекта. Это применимо как для новых пользователей, так и для существующих пользователей, которые ранее были приглашены. Требуется разрешение владельца или администратора.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого приглашение обижается

Идентификатор приглашения
invite_id True uuid

Идентификатор UUID приглашения, который будет обиден.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Повторное открытие потока комментариев

Повторно откройте ранее разрешенный поток комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев для повторного открытия

Возвращаемое значение

Имя Путь Тип Описание
данные
data CommentThread
change
metadata.change object

Изменения, внесенные в поток комментариев

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID вновь открытого потока комментариев

Повторяющийся процесс

Дублирование существующего процесса при необходимости в другой проект

Параметры

Имя Ключ Обязательно Тип Описание
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processId
processId True uuid
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Поиск в проекте

Выполнение операции поиска в определенном проекте, определяемой его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, в котором выполняется поиск

Искать
search True string

Строка запроса поиска

Общедоступный идентификатор процесса
process_public_id uuid

Необязательный идентификатор UUID процесса для ограничения поиска в рамках определенного процесса

Возвращаемое значение

Имя Путь Тип Описание
данные
data Answer
metadata
metadata object

Поиск пользователей

Поиск пользователей по проекту или процессу

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id uuid

Идентификатор проекта для ограничения поиска

Идентификатор процесса
process_id uuid

Идентификатор процесса для ограничения поиска

Идентификатор представления таблицы
table_view_id uuid

Идентификатор представления таблицы для ограничения поиска

Query
query True string

Строка запроса для поиска пользователей

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of SummaryUser
metadata
metadata object

Дополнительные метаданные

Получение вкладов пользователей

Получение количества вкладов в день, сделанных пользователем, идентифицируемым идентификатором Firebase

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, вклад которого требуется получить

Возвращаемое значение

Имя Путь Тип Описание
данные
data object

Вклады в день, ключ по дате

metadata
metadata object

Объект метаданных

Получение всех представлений для таблицы

Получение всех представлений, связанных с определенной таблицей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы, для которой должны быть получены представления.

Игнорировать столбцы
ignore_columns boolean

Пометка, чтобы указать, следует ли игнорировать данные столбцов в ответе.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableView
metadata
metadata object

Получение всех событий для ресурса

Извлеките все события, связанные с определенным ресурсом, отфильтрованные по различным критериям.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ресурса
resource_id True uuid

Идентификатор UUID ресурса, для которого необходимо получить события.

Тип
type True string

Тип ресурса (например, пользователь, процесс, таблица, проект).

Страница
page integer

Номер страницы для разбиения на страницы.

User
user uuid

Необязательный идентификатор UUID пользователя для фильтрации событий.

Команда
verb array

Необязательный список команд для фильтрации событий.

Дата начала
start_date date-time

Необязательная дата начала для фильтрации событий.

Дата окончания
end_date date-time

Необязательная дата окончания для фильтрации событий.

Искать
search string

Необязательный поисковый термин для фильтрации событий.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of Event
metadata
metadata object

Получение всех соединений таблиц

Извлеките все соединения, связанные с таблицей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, для которой необходимо получить соединения.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableJoin
metadata
metadata object

Получение данных диаграммы для представления

Получение данных для создания диаграммы на основе определенного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого запрашивается данные диаграммы.

Тип диаграммы
chart_type string

Тип диаграммы, для которой извлекается данные.

Показать легенду
show_legend boolean

Пометка, чтобы указать, следует ли отображать условные обозначения на диаграмме.

Отображение значений
show_values boolean

Пометка, чтобы указать, следует ли отображать значения на диаграмме.

Идентификатор значения столбца
column_value_id uuid

UUID столбца, который будет использоваться в качестве источника значений для диаграммы.

Идентификатор метки столбца
column_label_id uuid

UUID столбца, который будет использоваться в качестве источника меток для диаграммы.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
items
data object
metadata
metadata object

Получение достижений пользователей

Получение значков достижения пользователя по идентификатору Firebase

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, достижения которого необходимо извлечь

Возвращаемое значение

Имя Путь Тип Описание
createdProcesses
data.createdProcesses integer

Количество процессов, созданных пользователем

createdTables
data.createdTables integer

Количество таблиц, созданных пользователем

metadata
metadata object

Объект метаданных

Получение закрепленных проектов пользователя

Получение проектов, закрепленных пользователем по идентификатору Firebase

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, чьи закрепленные проекты должны быть извлечены

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
Участников
data.contributors integer

Число участников проекта

имя
data.name string

Имя проекта

primaryColour
data.primaryColour string

Основной цвет проекта

publicId
data.publicId uuid

Общедоступный идентификатор проекта

views
data.views integer

Количество представлений проекта

metadata
metadata object

Объект метаданных

Получение любимых проектов пользователя

Получение всех любимых проектов, вошедшего в систему пользователя, является частью

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
isDeleted
data.isDeleted boolean

Указывает, удаляется ли проект

имя
data.name string

Имя проекта

projectRole
data.projectRole string

Роль пользователя в проекте

publicId
data.publicId uuid

Общедоступный идентификатор проекта

metadata
metadata object

Дополнительные метаданные

Получение общедоступных вкладов пользователей

Получение общедоступных вкладов, внесенных пользователем, идентифицируемых идентификатором Firebase

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, общедоступный вклад которого требуется получить

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of Event
metadata
metadata object

Объект метаданных

Получение общедоступных проектов пользователя

Получение всех общедоступных проектов, в которых пользователь является членом

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of HomeProject
metadata
metadata object

Дополнительные метаданные

Получение одного представления для таблицы

Получите определенное представление по идентификатору таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, который требуется извлечь.

Игнорировать кэшированные параметры
ignore_cached_options boolean

Пометка, чтобы указать, следует ли игнорировать кэшированные параметры в ответе.

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableViewWithTable
metadata
metadata object

Получение отправленных уведомлений для проекта

Получение всех отправленных уведомлений для указанного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого извлекаются отправленные уведомления

Страница
page integer

Номер страницы выполнения уведомлений

Size
size integer

Количество выполнений уведомлений на страницу

Идентификатор уведомления
notification_id uuid

UUID определенного уведомления для фильтрации выполнений

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of NotificationExecution
metadata
metadata object

Получение переменных проекта

Получение всех переменных, связанных с указанным проектом

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, для которого извлекаются переменные

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
Клетки
data.cells array of object
имя
data.cells.column.name string
publicId
data.cells.column.publicId uuid
id
data.cells.id string
value
data.cells.value string
имя
data.name string
publicId
data.publicId uuid
metadata
metadata object

Получение пользовательских проектов

Получение всех проектов, вошедшего в систему пользователя, является частью

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of HomeProject
metadata
metadata object

Дополнительные метаданные

Получение пользовательских шаблонов

Получение всех шаблонов, к пользователям, вошедшего в систему, имеет доступ к

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
создано кем
data.createdBy SummaryUser
metadata
metadata object

Получение потока комментариев

Получение определенного потока комментариев по идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

Идентификатор UUID потока комментариев для получения

Возвращаемое значение

Имя Путь Тип Описание
данные
data CommentThread
metadata
metadata object

Получение потоков комментариев по ссылке

Получение всех потоков комментариев, связанных с определенной ссылкой

Параметры

Имя Ключ Обязательно Тип Описание
Ссылочный тип
reference_type True string

Тип ссылки (process_section, таблицы или table_view), связанного с потоками комментариев

Идентификатор ссылки
reference_id True uuid

UUID ссылки, связанной с потоками комментариев

Основная ссылка
main_reference string

Необязательная ссылка на основную ссылку для дополнительной фильтрации

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of CommentThread
metadata
metadata object

Получение приглашенных участников проекта

Получение всех приглашенных участников для указанного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого извлекаются приглашенные участники

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of InvitedMember
metadata
metadata object

Получение процессов в проекте

Получение всех процессов, связанных с определенным проектом, идентифицируемым его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, для которого необходимо получить процессы

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of SimpleProcess
metadata
metadata object

Получение раздела "Процесс"

Получение определенного раздела процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Основной родительский раздел
main_parent_section boolean

Флаг для получения основного родительского раздела раздела процесса

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Получение разделов удаленного процесса

Получение всех удаленных разделов определенного процесса с необязательным фильтром для определенного раздела процесса

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для извлечения удаленных разделов из

Идентификатор раздела процесса
process_section_id uuid

Необязательный идентификатор UUID определенного раздела процесса для фильтрации удаленных разделов

Возвращаемое значение

Получение разрешений на ресурсы

Получение разрешений для указанного ресурса, например таблицы, представления таблицы или процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Resource
resource True string

Тип ресурса, для которого требуется получить разрешения. Допустимыми параметрами являются "process", "table" или "table_view".

Идентификатор ресурса
resource_id True uuid

UUID ресурса, для которого требуется получить разрешения.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of AccessPolicy
metadata
metadata object

Получение ресурсов проекта

Получение ресурсов, связанных с определенным проектом, определяемым его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, ресурсы которого необходимо извлечь

adminView
adminView boolean
excludeProcesses
excludeProcesses boolean
excludeTables
excludeTables boolean
onlyDeleted
onlyDeleted boolean
projectPermissions
projectPermissions boolean
TypeId
typeId string

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
имя
data.name string

Имя ресурса.

процесс
data.process PermissionedProcess
table
data.table SimpleDocumentTable
type
data.type string

Тип ресурса (процесса или таблицы)

metadata
metadata object

Получение сведений

Получение сведений о текущем пользователе

Возвращаемое значение

Имя Путь Тип Описание
данные
data User
metadata
metadata object

Объект метаданных

Получение сведений о конкретном пользователе

Получение сведений о конкретном пользователе

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя для получения

Возвращаемое значение

Имя Путь Тип Описание
данные
data User
metadata
metadata object

Объект метаданных

Получение сведений о пользователе по общедоступному идентификатору

Получение сведений о конкретном пользователе по их общедоступному идентификатору

Параметры

Имя Ключ Обязательно Тип Описание
Общедоступный идентификатор
public_id True uuid

Общедоступный идентификатор UUID пользователя для получения

Возвращаемое значение

Имя Путь Тип Описание
данные
data User
metadata
metadata object

Объект метаданных

Получение сведений о проекте

Получение подробных сведений о конкретном проекте, определяемом его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта для получения

Возвращаемое значение

Имя Путь Тип Описание
Папки
data.folders array of object
дочерние папки
data.folders.childFolders array of object
имя
data.folders.childFolders.name string
имя
data.folders.name string
projectDetails
data.projectDetails SimpleProject
роль
data.role string

Роль пользователя в проекте

metadata
metadata object

Получение сведений о процессе

Получение подробных сведений о конкретном процессе с помощью UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для получения

Исключение дочерних элементов
exclude_children boolean

Флаг для исключения дочерних элементов из ответа процесса

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Получение секретов проекта

Получение всех секретов для указанного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого необходимо получить секреты

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of ProjectSecret
metadata
metadata object

Получение списка всех поддерживаемых типов событий

Получите список всех поддерживаемых типов событий для уведомлений.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of string
metadata
metadata object

Получение статистики по столбцам таблицы

Получение статистических данных для столбцов в определенном представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого требуется получить статистику.

Filter
filter string

Фильтры для применения к сбору статистических данных.

Sum, avg, max, min, count
sum, avg, max, min, count array

Укажите столбцы для выполнения операций суммы, среднего, максимального, минимального или подсчета.

Идентификатор процесса
process_id uuid

Необязательный идентификатор UUID процесса для фильтрации данных.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableColumnWithAggregation
metadata
metadata object

Получение статистики потока комментариев

Получение статистики для потоков комментариев на основе ссылочного типа и основного идентификатора ссылки

Параметры

Имя Ключ Обязательно Тип Описание
Ссылочный тип
reference_type True string

Тип ссылки (process_section, таблицы или table_view), для которой требуется собрать статистику

Основной идентификатор ссылки
main_reference_id uuid

UUID основной ссылки для сбора статистики

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of CommentThreadStats
metadata
metadata object

Получение статистики столбцов таблицы

Получение статистики для столбцов таблиц на основе указанных параметров.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, для которой извлекается статистика

Aggregation
aggregation string

Функции агрегирования для применения к столбцам

Filter
filter string

Критерии фильтрации для столбцов

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableColumnWithAggregation
metadata
metadata object

Получение столбцов таблицы

Извлеките все активные столбцы определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, столбцы которой необходимо извлечь

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableColumn
metadata
metadata object

Получение строк таблицы

Извлеките строки из таблицы на основе предоставленных параметров запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, из которой должны быть извлечены строки

Страница
page integer

Номер страницы для разбиения на страницы

Size
size integer

Количество элементов на страницу для разбиения на страницы

Сортировать
sort string

Критерии сортировки строк таблицы

Filter
filter string

Критерии фильтрации строк таблицы

Последнее обновление в
last_updated_at date-time

Фильтрация строк, обновленных после этой даты

Последнее создание в
last_created_at date-time

Фильтрация строк, созданных после этой даты

Следующий маркер страницы
next_page_token string

Маркер получения следующей страницы результатов

Колонны
columns array

Конкретные столбцы для включения в ответ

Отдельные столбцы
distinct_columns array

Столбцы для применения отдельной фильтрации

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
next_page_token
metadata.next_page_token string
page
metadata.page integer
size
metadata.size integer
итог
metadata.total integer

Получение таблиц и его строк

Получение таблицы и строк на основе предоставленных параметров

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для получения

Страница
page integer

Номер страницы для разбиения на страницы

Size
size integer

Количество элементов на страницу для разбиения на страницы

Сортировать
sort string

Критерии сортировки строк таблицы

Filter
filter string

Критерии фильтрации строк таблицы

Последнее обновление в
last_updated_at date-time

Фильтрация строк, обновленных после этой даты

Последнее создание в
last_created_at date-time

Фильтрация строк, созданных после этой даты

Следующий маркер страницы
next_page_token string

Маркер получения следующей страницы результатов

Колонны
columns array

Конкретные столбцы для включения в ответ

Отдельные столбцы
distinct_columns array

Столбцы для применения отдельной фильтрации

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
page
metadata.page integer

Текущий номер страницы

size
metadata.size integer

Количество элементов на странице

итог
metadata.total integer

Общее количество строк в таблице

Получение таблиц проекта

Получение таблиц, связанных с определенным проектом, идентифицируемым его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого извлекаются таблицы

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of Table
metadata
metadata object

Получение тега по общедоступному идентификатору

Получение тега по его общедоступному идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Общедоступный идентификатор тега
tag_id True string

Общедоступный идентификатор извлекаемого тега.

Возвращаемое значение

Имя Путь Тип Описание
данные
data Tag
metadata
metadata object

Получение тегов проекта

Получение всех тегов, связанных с указанным проектом

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого необходимо извлечь теги

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
Клетки
data.cells array of object
имя
data.cells.column.name string
publicId
data.cells.column.publicId uuid
id
data.cells.id string
value
data.cells.value string
имя
data.name string
publicId
data.publicId uuid
metadata
metadata object

Получение уведомлений для проекта

Извлеките все уведомления, связанные с определенным проектом. Эта конечная точка доступна только пользователям с разрешениями уровня владельца для проекта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, для которого извлекаются уведомления

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of Notification
metadata
metadata object

Получение удаленных процессов в проекте

Получение всех удаленных процессов, связанных с определенным проектом, идентифицируемым его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, для которого извлекаются удаленные процессы

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of SimpleProcess
metadata
metadata object

Получение удаленных таблиц в проекте

Извлеките все удаленные таблицы из определенного проекта, определяемого его UUID. Доступны только владельцы проектов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого извлекаются удаленные таблицы.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of Table
metadata
metadata object

Получение уникальных значений для столбца

Получение уникальных или уникальных значений для определенного столбца в представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы.

Идентификатор столбца
column_id True uuid

Идентификатор UUID столбца, для которого извлекаются отдельные значения.

Filter
filter string

Фильтры для применения к извлечению данных.

Столбцы группы
group_columns array

Необязательные столбцы для группировки различных значений.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of string
metadata
metadata object

Получение уникальных значений для столбца

Получение списка уникальных (уникальных) значений для указанного столбца в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей столбец

Идентификатор столбца
column_id True uuid

UUID столбца, для которого извлекаются уникальные значения

Filter
filter string

Критерии фильтрации для отдельных значений

Столбцы группы
group_columns array

Указание столбцов для значений группировки

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of string
metadata
metadata object

Получение управляемых и администрирование проектов пользователей

Получение всех проектов, в которых пользователь является владельцем или администратором

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of HomeProject
metadata
metadata object

Дополнительные метаданные

Получение файла для ячейки таблицы

Получение файла, связанного с определенной ячейкой в таблице.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей файл.

Идентификатор столбца
column_id True uuid

UUID столбца, содержащего ячейку.

Filename
filename True string

Имя извлекаемого файла.

Возвращаемое значение

response
binary

Получение фактических данных представления таблицы

Получение фактических данных для определенного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого извлекаются данные.

Filter
filter string

Фильтры для применения к извлечению данных.

Сортировать
sort string

Сортировка параметров для извлечения данных.

Страница
page integer

Номер страницы для разбиения на страницы.

Size
size integer

Количество элементов на страницу для разбиения на страницы.

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
next_page_token
metadata.next_page_token string
size
metadata.size integer
итог
metadata.total integer

Получение членов проекта

Получение всех элементов, связанных с указанным проектом

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого необходимо получить элементы

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of ProjectListWithUserTags
metadata
metadata object

Порядок раздела обновления

Обновите порядок разделов процесса в процессе.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
parentId
parentId uuid
позиция
position integer
sectionId
sectionId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Потоковая передача всех строк для представления

Потоковая передача данных всех строк для определенного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого запрашивается потоковая передача данных.

Filter
filter string

Фильтры для применения к потоковым данным.

Сортировать
sort string

Сортировка параметров потоковой передачи данных.

Идентификатор процесса
process_id uuid

Необязательный идентификатор UUID процесса для фильтрации данных.

Страница
page integer

Номер страницы для разбиения на страницы

Size
size integer

Количество элементов на страницу для разбиения на страницы

Возвращаемое значение

response
binary

Потоковая передача всех строк для таблицы

Потоковая передача данных всех строк для определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для потоковой передачи строк.

Filter
filter string

Фильтры для применения к потоковым данным.

Сортировать
sort string

Сортировка параметров потоковой передачи данных.

Страница
page integer

Номер страницы для разбиения на страницы

Size
size integer

Количество элементов на страницу для разбиения на страницы

Возвращаемое значение

response
binary

Предварительная версия результирующей строки из входных данных

Просмотр результирующей строки из заданных входных данных в определенном представлении таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого создается предварительная версия строки.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowData
rowData True object

Возвращаемое значение

Имя Путь Тип Описание
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Приглашение нескольких пользователей в проект

Пригласите нескольких пользователей присоединиться к проекту по электронной почте. Если пользователи уже существуют, они добавляются напрямую, в противном случае отправляется приглашение. Требуется разрешение владельца или администратора.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, в который приглашены пользователи

сообщения электронной почты
emails array of email
tags
tags array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Приглашение пользователя в проект

Пригласите одного пользователя присоединиться к проекту по электронной почте. Если пользователь уже существует, они добавляются напрямую; в противном случае отправляется приглашение. Требуется разрешение владельца или администратора.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, в который приглашен пользователь

электронная почта
email True email
tags
tags array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Проверка столбца представлений используется в

Извлеките все представления, в которых используется определенный столбец таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей столбец

Идентификатор столбца
column_id True uuid

UUID столбца для проверки представлений

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableView
metadata
metadata object

Проверка таблицы процессов используется в

Проверьте и возвратите список процессов, соединений таблиц и выбирает место использования указанной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для проверки использования

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
link
data.link string

Прямая ссылка на процесс, присоединение или выбор

имя
data.name string

Имя процесса, присоединение или выбор места использования таблицы

type
data.type string

Тип использования (process, sourceJoin, targetJoin, sourceSelect и т. д.)

metadata
metadata object

Процесс восстановления

Восстановление удаленного процесса, определяемого его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для восстановления

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Процесс удаления

Удаление процесса, определяемого его идентификатором UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Процесс экспорта

Экспорт определенного процесса с помощью UUID в различные форматы (PDF или DOCX)

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для экспорта

Формат экспорта
export_format string

Формат экспорта (PDF или DOCX)

Ссылки на таблицы
table_links boolean

Включение ссылок на таблицу в экспорт

Description
description boolean

Включение описания процесса в экспорт

Формат страницы
page_format string

Формат страницы для экспорта

Ориентация страницы
page_orientation string

Ориентация страницы для экспорта

Тип шрифта
font_type string

Тип шрифта для экспорта

Размер шрифта
font_size integer

Размер шрифта для экспорта

Возвращаемое значение

response
binary

Раздел "Повторяющийся процесс"

Дублирование определенного раздела процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса для дублирования.

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Раздел "Повторяющийся процесс"

Повторяйте определенный раздел процесса асинхронно.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса для дублирования.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Раздел процесса восстановления

Восстановите ранее удаленный раздел процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса, который необходимо восстановить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Разрешение потока комментариев

Разрешение потока комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев для разрешения

Возвращаемое значение

Имя Путь Тип Описание
данные
data CommentThread
change
metadata.change object

Изменения, внесенные в поток комментариев

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID разрешенного потока комментариев

Сброс ответа процесса

Сброс существующего ответа процесса на исходное состояние.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID ответа процесса, который необходимо сбросить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Синхронизация таблицы с интеграцией

Синхронизация таблицы с указанной интеграцией.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для синхронизации.

Имя интеграции
integration_name True string

Имя интеграции для синхронизации.

companyId
companyId string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
enterpriseId
enterpriseId string
folderId
folderId string
hubId
hubId string
licenseId
licenseId string
projectId
projectId string
projectIds
projectIds array of string
topFolderId
topFolderId string
type
type string

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Скачивание данных в виде CSV-файла

Скачайте данные определенного представления таблицы в формате CSV.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, который нужно скачать в формате CSV.

Filter
filter string

Фильтры для применения к данным CSV.

Сортировать
sort string

Сортировка параметров для данных CSV.

Идентификатор процесса
process_id uuid

Необязательный идентификатор UUID процесса для фильтрации данных.

Возвращаемое значение

response
binary

Скачивание данных таблицы в формате CSV

Скачайте данные указанной таблицы в виде CSV-файла.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для скачивания данных из

Сортировать
sort string

Критерии сортировки строк таблицы

Filter
filter string

Критерии фильтрации строк таблицы

Возвращаемое значение

response
binary

Скачивание изображения диаграммы

Скачайте файл изображения диаграммы на основе данных из определенного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, для которого создается изображение диаграммы.

Тип диаграммы
chart_type string

Тип диаграммы, для которой создается изображение.

Показать легенду
show_legend boolean

Пометка, чтобы указать, следует ли включать условные обозначения на изображение диаграммы.

Отображение значений
show_values boolean

Пометка, чтобы указать, следует ли включать значения в изображение диаграммы.

Идентификатор значения столбца
column_value_id uuid

UUID столбца, используемого в качестве источника значений для изображения диаграммы.

Идентификатор метки столбца
column_label_id uuid

UUID столбца, используемого в качестве источника меток для изображения диаграммы.

Возвращаемое значение

response
binary

Создание запроса на скачивание сквозного руководства

Вызов API сквозного руководства к внешней исходной системе для скачивания файлов.

Параметры

Имя Ключ Обязательно Тип Описание
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
данные
data
headers
headers
method
method True string
onBehalfUserId
onBehalfUserId uuid
путь
path True string
sourceSystem
sourceSystem True string

Возвращаемое значение

response
binary

Создание индекса в столбце таблицы

Создайте индекс для одной или нескольких столбцов таблицы для повышения производительности запросов.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, для которой необходимо создать индексы.

publicId
publicId True uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of TableColumn
metadata
metadata object

Создание ключа API для пользователя

Создание ключа API для пользователя, вошедшего в систему.

Параметры

Имя Ключ Обязательно Тип Описание
имя
name string

Возвращаемое значение

Имя Путь Тип Описание
данные
data ApiKey
metadata
metadata object

Создание комментария

Создание комментария в определенном потоке комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев, в который добавляется комментарий

commentText
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data Comment
change
metadata.change object

Изменения, внесенные в эту операцию

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID только что созданного комментария

Создание нескольких разделов процесса

Создание нескольких новых разделов в рамках указанного процесса с дополнительным родительским разделом

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса, в котором будут созданы новые разделы

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
имя
name True string
parentId
parentId uuid
plaintextDescription
plaintextDescription string

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
resourceIds
metadata.resourceIds array of string

Список идентификаторов UUID для только что созданных разделов процесса

Создание нового пользователя

Создание нового пользователя

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
email True email
имя
name True string
пароль
password True string
projectId
projectId uuid

Возвращаемое значение

Имя Путь Тип Описание
данные
data User
metadata
metadata object

Создание нового представления для таблицы

Создайте новое представление для определенной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы, для которой необходимо создать представление.

allowContributorDelete
allowContributorDelete boolean
chartSettings
chartSettings
свернутыйGroupView
collapsedGroupView boolean
backgroundColour
backgroundColour True string
columnId
columnId uuid
columnName
columnName True string
Тип фильтра
filterType True string
fontColour
fontColour True string
multipleValues
multipleValues array of
value
value
columnId
columnId uuid
columnName
columnName True string
описание
description
locked
locked boolean
required
required boolean
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
disableNewRow
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
columnId
columnId uuid
columnName
columnName True string
Тип фильтра
filterType True string
multipleValues
multipleValues array of
orGroup
orGroup string
value
value
frozenIndex
frozenIndex integer
columnId
columnId uuid
columnName
columnName True string
направление
direction True string
includeAllColumns
includeAllColumns boolean
isDefault
isDefault boolean
имя
name True string
rowHeight
rowHeight integer
columnId
columnId uuid
columnName
columnName True string
направление
direction True string
type
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableView
metadata
metadata object

Создание нового процесса

Создание нового процесса в указанном проекте

Параметры

Имя Ключ Обязательно Тип Описание
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
имя
name True string
projectId
projectId True uuid
type
type True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Process
change
metadata.change object

Изменения, внесенные во время создания процесса

событие
metadata.event string

Тип события, например process.created

resourceId
metadata.resourceId uuid

Идентификатор UUID созданного процесса

Создание ответа на новый процесс

Создайте новый ответ для раздела процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
type
type string

Возвращаемое значение

Имя Путь Тип Описание
данные
data ProcessResponse
metadata
metadata object

Создание потока комментариев

Создание потока комментариев

Параметры

Имя Ключ Обязательно Тип Описание
commentText
commentText True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
mainReferenceId
mainReferenceId uuid
referenceId
referenceId True uuid
referenceType
referenceType True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data CommentThread
change
metadata.change object

Изменения, внесенные в эту операцию

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID нового созданного потока комментариев

Создание проекта

Создание проекта с указанным именем

Параметры

Имя Ключ Обязательно Тип Описание
имя
name True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Создание раздела "Создание процесса"

Создание нового раздела в рамках указанного процесса с возможностью задания родительского раздела

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса для создания нового раздела в

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
имя
name True string
parentId
parentId uuid
plaintextDescription
plaintextDescription string

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Создание разделов процесса

Создание нескольких разделов в процессе

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса, в котором будут созданы новые разделы

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
описание
description
имя
name True string
parentId
parentId uuid
plaintextDescription
plaintextDescription string

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of MortaProcessSection
metadata
metadata object

Создание разрешений для ресурса

Создание разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Параметры

Имя Ключ Обязательно Тип Описание
attributeId
attributeId uuid
attributeKind
attributeKind True string
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
resourceId
resourceId True uuid
resourceKind
resourceKind True string
роль
role True integer
tagReferenceId
tagReferenceId string

Возвращаемое значение

Имя Путь Тип Описание
данные
data AccessPolicy
metadata
metadata object

Создание секрета проекта

Создание нового секрета для указанного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, в котором будет создан секрет.

имя
name True string
value
value True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data ProjectSecret
metadata
metadata object

Создание сквозного запроса к исходной системе

Вызов API сквозного руководства к внешней исходной системе.

Параметры

Имя Ключ Обязательно Тип Описание
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
данные
data
headers
headers
method
method True string
onBehalfUserId
onBehalfUserId uuid
путь
path True string
sourceSystem
sourceSystem True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data IntegrationsPassthroughResponse
metadata
metadata object

Создание соединения таблицы

Создайте соединение между двумя таблицами.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для создания соединения.

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dataColumns
dataColumns array of string
isOneToMany
isOneToMany boolean
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
joinViewId
joinViewId string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
metadata
metadata object

Создание стиля заголовка проекта

Создание стиля заголовка для определенного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого создается стилизация заголовков

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Создание столбца таблицы

Добавьте новый столбец в существующую таблицу.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, в которую будет добавлен столбец

aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
isIndexed
isIndexed boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
mortaSynced
mortaSynced integer
имя
name True string
procoreSynced
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
thousandSeparator
thousandSeparator boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableColumn
metadata
metadata object

Создание таблицы документов

Создайте новую таблицу документов в проекте.

Параметры

Имя Ключ Обязательно Тип Описание
aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
manualOptions
manualOptions array of string
tableOptions
tableOptions
mortaSynced
mortaSynced integer
имя
name True string
procoreSynced
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
thousandSeparator
thousandSeparator boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
isOneToMany
isOneToMany boolean
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string
joinTableName
joinTableName string
joinViewId
joinViewId string
joinViewName
joinViewName string
имя
name True string
projectId
projectId True uuid
type
type string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Table
metadata
metadata object

Создание уведомления

Создайте новое уведомление для определенного проекта.

Параметры

Имя Ключ Обязательно Тип Описание
описание
description True string
processes
processes array of uuid
projectId
projectId True uuid
tables
tables array of uuid
resource
resource True string
глагол
verb True string
webhookUrl
webhookUrl True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data Notification
metadata
metadata object

Средства реагирования на процессы обновления

Обновление списка респондентов для заданного процесса, определяемого его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса, ответчики которого должны быть обновлены

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
Реагирования
responders array of string

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcess
metadata
metadata object

Строка Upsert в таблице

Добавьте или обновите строку в указанной таблице на основе уникального значения столбца.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

Идентификатор UUID таблицы для изменения строки

processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
processPublicId
processPublicId uuid
processResponsePublicId
processResponsePublicId uuid
processSectionPublicId
processSectionPublicId uuid
projectId
projectId uuid
rowData
rowData True object
sortOrder
sortOrder number
upsertColumnName
upsertColumnName True string

Возвращаемое значение

Имя Путь Тип Описание
данные
data array of object
publicId
data.publicId string
rowData
data.rowData object
sortOrder
data.sortOrder number
metadata
metadata object

Удаление всех строк из таблицы

Удаляет все строки из указанной таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, из которой удаляются все строки.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление интеграции из таблицы

Удалите определенную интеграцию из таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, из которой будет удалена интеграция.

Имя интеграции
integration_name True string

Имя удаленной интеграции.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление ключа API

Удаление ключа API для пользователя, вошедшего в систему

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор ключа API
api_key_id True uuid

Идентификатор UUID ключа API для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Дополнительные метаданные

Удаление комментария

Удаление определенного комментария в потоке комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев, содержащего комментарий

Идентификатор комментария
comment_id True uuid

UUID комментария, который необходимо удалить

Возвращаемое значение

Имя Путь Тип Описание
данные
data Comment
change
metadata.change object

Изменения, внесенные в комментарий

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID удаленного комментария

Удаление одного уведомления

Удалите определенное уведомление по его идентификатору.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True uuid

Идентификатор UUID уведомления, который необходимо удалить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление определенных строк

Удаление определенных строк из представления таблицы на основе идентификаторов строк.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, из которого удаляются строки.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление ответа процесса

Удаление определенного ответа процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса.

Идентификатор ответа процесса
process_response_id True uuid

Идентификатор UUID ответа процесса, который будет удален.

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Удаление пользователя из проекта

Удаление пользователя из определенного проекта, определяемого идентификатором UUID проекта и идентификатором Пользователя Firebase

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта

Идентификатор Firebase
firebase_id True string

Идентификатор Firebase пользователя, который нужно удалить

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Удаление потока комментариев

Удаление потока комментариев

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор потока примечания
comment_thread_id True uuid

UUID потока комментариев для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data CommentThread
change
metadata.change object

Изменения, внесенные в поток комментариев

событие
metadata.event string

Тип события для операции

resourceId
metadata.resourceId string

UUID удаленного потока комментариев

Удаление представления таблицы

Удаление определенного представления таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, который необходимо удалить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление приглашения проекта

Удаление приглашения в проект

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, из которого требуется удалить приглашение

Идентификатор приглашения
invite_id True uuid

Идентификатор UUID приглашения, который будет удален

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление проекта

Удаление определенного проекта, определяемого его UUID

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, который необходимо удалить

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление раздела "Процесс"

Удаление определенного раздела процесса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор процесса
process_id True uuid

Идентификатор UUID процесса.

Идентификатор раздела процесса
process_section_id True uuid

Идентификатор UUID раздела процесса, который необходимо удалить.

Возвращаемое значение

Имя Путь Тип Описание
данные
data MortaProcessSection
metadata
metadata object

Удаление разрешений для ресурса

Удаление разрешений для определенного ресурса (например, таблицы, представления таблицы или процесса).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id True uuid

UUID политики для удаления.

Удаление секрета проекта

Удаление определенного секрета из проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

UUID проекта, из которого будет удален секрет.

Идентификатор секрета
secret_id True uuid

Идентификатор UUID секрета, который необходимо удалить

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление соединения таблицы

Удаление соединения из таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, из которой будет удалено соединение.

Идентификатор соединения
join_id True uuid

UUID для удаления соединения.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление стиля заголовка верхнего проекта

Удаление стиля верхнего заголовка для определенного проекта

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор проекта
project_id True uuid

Идентификатор UUID проекта, для которого удаляется стилизация верхнего заголовка

Возвращаемое значение

Имя Путь Тип Описание
данные
data SimpleProject
metadata
metadata object

Удаление столбца таблицы

Удалите определенный столбец из таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, содержащей столбец

Идентификатор столбца
column_id True uuid

UUID столбца для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление строк таблицы

Удалите все строки или определенные строки из таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы, из которой должны быть удалены строки.

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удаление тега из пользователя

Удаление тега из определенного пользователя

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
user_id True uuid

Общедоступный идентификатор UUID пользователя, из которого нужно удалить тег

Идентификатор тега
tag_id True uuid

Общедоступный идентификатор UUID тега для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Удалить таблицу

Удалите указанную таблицу по идентификатору UUID.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор таблицы
table_id True uuid

UUID таблицы для удаления

Возвращаемое значение

Имя Путь Тип Описание
данные
data string
metadata
metadata object

Установка представления в качестве представления по умолчанию

Указать определенное представление таблицы в качестве представления по умолчанию для таблицы.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор представления
view_id True uuid

Идентификатор UUID представления таблицы, заданный по умолчанию.

Возвращаемое значение

Имя Путь Тип Описание
данные
data TableView
metadata
metadata object

Определения

AccessAttribute

Имя Путь Тип Описание
documentTable
documentTable Table3
добрый
kind string
project
project Project
publicId
publicId uuid
tag
tag Tag
Пользователь
user User3

Политика доступа

Имя Путь Тип Описание
accessAttribute
accessAttribute AccessAttribute
accessResource
accessResource AccessResource
publicId
publicId uuid
роль
role integer
roleLabel
roleLabel string

AccessResource

Имя Путь Тип Описание
documentTable
documentTable Table3
добрый
kind string
процесс
process Process
publicId
publicId uuid

Действие

Имя Путь Тип Описание
добрый
kind string
publicId
publicId uuid
webhookUrl
webhookUrl string

Ответ

Имя Путь Тип Описание
ответы
answers array of SearchProjectAnswerResources
resources
resources array of SearchProjectResources

Ключ API (ApiKey)

Имя Путь Тип Описание
hash
hash string
имя
name string
prefix
prefix string
publicId
publicId uuid

Диаграмма

Имя Путь Тип Описание
chartType
chartType string
columnLabelId
columnLabelId uuid
columnValueId
columnValueId uuid
showLegend
showLegend boolean
showValues
showValues boolean

Цвет

Имя Путь Тип Описание
backgroundColour
backgroundColour string
columnId
columnId uuid
columnName
columnName string
Тип фильтра
filterType string
fontColour
fontColour string
multipleValues
multipleValues array of
value
value

Комментарий

Имя Путь Тип Описание
commentText
commentText string
createdAt
createdAt date-time
deletedAt
deletedAt date-time
isOwner
isOwner
publicId
publicId uuid
обновлено
updatedAt date-time
Пользователь
user SummaryUser

CommentThread

Имя Путь Тип Описание
comments
comments array of Comment
createdAt
createdAt date-time
deletedAt
deletedAt date-time
isCommentInitiator
isCommentInitiator
publicId
publicId uuid
ResolvedAt
resolvedAt date-time
Распознавателя
resolver User1
обновлено
updatedAt date-time

CommentThreadStats

Имя Путь Тип Описание
openCommentThreads
openCommentThreads integer
referenceId
referenceId uuid
resolvedCommentThreads
resolvedCommentThreads integer

Черновики

Имя Путь Тип Описание
содержимое
content DraftjsContent

DraftjsBlock

Имя Путь Тип Описание
данные
data
глубина
depth integer
entityRanges
entityRanges array of
inlineStyleRanges
inlineStyleRanges array of
key
key string
текст
text string
type
type string

DraftjsContent

Имя Путь Тип Описание
Блоки
blocks array of DraftjsBlock
entityMap
entityMap

Event

Имя Путь Тип Описание
change
change
changeId
changeId string
context
context
contextProcessId
contextProcessId integer
contextProcessResponseId
contextProcessResponseId integer
contextProcessSectionId
contextProcessSectionId integer
contextTableColumnId
contextTableColumnId integer
contextTableId
contextTableId integer
contextTableViewId
contextTableViewId integer
createdAt
createdAt date-time
projectId
projectId integer
publicId
publicId uuid
resource
resource string
resourcePublicId
resourcePublicId uuid
userId
userId integer
глагол
verb string

Filter

Имя Путь Тип Описание
columnId
columnId uuid
columnName
columnName string
Тип фильтра
filterType string
multipleValues
multipleValues array of
orGroup
orGroup string
value
value

Группа

Имя Путь Тип Описание
columnId
columnId uuid
columnName
columnName string
направление
direction string

HeadingStyle

Имя Путь Тип Описание
bold
bold boolean
цвет
colour string
fontSize
fontSize number
курсив
italic boolean
уровень
level integer
нумерующий стиль
numberingStyle integer
publicId
publicId uuid
startAt0
startAt0 boolean
подчеркнутый
underline boolean

HomeProject

Имя Путь Тип Описание
deletedAt
deletedAt date-time
hideProcessCreated
hideProcessCreated boolean
isDeleted
isDeleted boolean
mfaRequired
mfaRequired boolean
имя
name string
primaryColour
primaryColour string
publicId
publicId string

IntegrationsPassthroughResponse

Имя Путь Тип Описание
body
body
Тип контента
contentType string
headers
headers
статус
status string

ПриглашенныйMember

Имя Путь Тип Описание
createdAt
createdAt date-time
электронная почта
email string
invitedBy
invitedBy SummaryUser
publicId
publicId uuid
tags
tags array of Tag

MortaProcess

Имя Путь Тип Описание
allowComments
allowComments boolean
allowDuplication
allowDuplication boolean
children
children array of ProcessSection1
createdAt
createdAt date-time
deletedAt
deletedAt date-time
описание
description
expandByDefault
expandByDefault boolean
isDeleted
isDeleted boolean
isTemplate
isTemplate boolean
logo
logo string
имя
name string
publicId
publicId uuid
templateCategory
templateCategory string
type
type string
обновлено
updatedAt date-time
variableValues
variableValues array of string
variables
variables array of string

MortaProcessResponse

Имя Путь Тип Описание
одобренный
approved boolean
createdAt
createdAt date-time
deletedAt
deletedAt date-time
dueDate
dueDate date-time
expireResponse
expireResponse boolean
isDeleted
isDeleted boolean
pdfIncludeResponse
pdfIncludeResponse boolean
позиция
position integer
publicId
publicId uuid
resetAfterResponse
resetAfterResponse boolean
Реагирования
responders array of string
response
response
responseDate
responseDate date-time
type
type string
typeOptions
typeOptions
обновлено
updatedAt date-time
Пользователь
user SummaryUser
userResponders
userResponders array of SummaryUser

MortaProcessSection

Имя Путь Тип Описание
children
children array of MortaProcessSection
createdAt
createdAt date-time
deletedAt
deletedAt date-time
описание
description Draftjs
isDeleted
isDeleted boolean
имя
name string
openCommentThreads
openCommentThreads integer
pageBreakBefore
pageBreakBefore boolean
parentId
parentId uuid
pdfIncludeDescription
pdfIncludeDescription boolean
pdfIncludeSection
pdfIncludeSection boolean
позиция
position integer
publicId
publicId uuid
Ответы
responses array of ProcessResponse
статус
status integer

Notification

Имя Путь Тип Описание
Действия
actions array of Action
createdAt
createdAt date-time
описание
description string
processes
processes array of Process
publicId
publicId uuid
tables
tables array of Table1
триггеры
triggers array of Trigger
Пользователь
user SummaryUser

Уведомление1

Имя Путь Тип Описание
Действия
actions array of Action
createdAt
createdAt date-time
описание
description string
processes
processes array of Process
publicId
publicId uuid
tables
tables array of Table1
триггеры
triggers array of Trigger

NotificationExecution

Имя Путь Тип Описание
createdAt
createdAt date-time
описание
description string
являетсяУспешным
isSuccess boolean
уведомление
notification Notification1
publicId
publicId uuid
обновлено
updatedAt date-time

PermissionedProcess

Имя Путь Тип Описание
createdAt
createdAt date-time
deletedAt
deletedAt date-time
logo
logo string
имя
name string
publicId
publicId uuid
type
type string
обновлено
updatedAt date-time

Процедура

Имя Путь Тип Описание
имя
name string
publicId
publicId uuid

ProcessResponse

Имя Путь Тип Описание
одобренный
approved boolean
createdAt
createdAt date-time
deletedAt
deletedAt date-time
dueDate
dueDate date-time
expireResponse
expireResponse boolean
isDeleted
isDeleted boolean
pdfIncludeResponse
pdfIncludeResponse boolean
позиция
position integer
publicId
publicId uuid
resetAfterResponse
resetAfterResponse boolean
Реагирования
responders array of string
response
response
responseDate
responseDate date-time
type
type string
typeOptions
typeOptions
обновлено
updatedAt date-time
Пользователь
user SummaryUser
userResponders
userResponders array of SummaryUser

ProcessSection

Имя Путь Тип Описание
имя
name string
publicId
publicId uuid
статус
status integer

ProcessSection1

Имя Путь Тип Описание
children
children array of ProcessSection1
createdAt
createdAt date-time
deletedAt
deletedAt date-time
описание
description Draftjs
isDeleted
isDeleted boolean
имя
name string
openCommentThreads
openCommentThreads integer
pageBreakBefore
pageBreakBefore boolean
parentId
parentId uuid
pdfIncludeDescription
pdfIncludeDescription boolean
pdfIncludeSection
pdfIncludeSection boolean
позиция
position integer
publicId
publicId uuid
Ответы
responses array of ProcessResponse
статус
status integer

Проект

Имя Путь Тип Описание
имя
name string
publicId
publicId string

ProjectList

Имя Путь Тип Описание
createdAt
createdAt date-time
любимый
favourite boolean
projectRole
projectRole string
обновлено
updatedAt date-time
Пользователь
user User4

ProjectListWithUserTags

Имя Путь Тип Описание
createdAt
createdAt date-time
любимый
favourite boolean
projectRole
projectRole string
обновлено
updatedAt date-time
Пользователь
user User2

ProjectSecret

Имя Путь Тип Описание
createdAt
createdAt date-time
имя
name string
publicId
publicId uuid
обновлено
updatedAt date-time
value
value string

SearchProjectAnswerResources

Имя Путь Тип Описание
label
label string
link
link string
originalText
originalText string
сходство
similarity number
текст
text string

SearchProjectResources

Имя Путь Тип Описание
link
link string
текст
text string
type
type string

SelectOptionsLookup

Имя Путь Тип Описание
manualOptions
manualOptions array of string
tableOptions
tableOptions

SimpleDocumentTable

Имя Путь Тип Описание
createdAt
createdAt date-time
defaultViewId
defaultViewId string
deletedAt
deletedAt date-time
isDeleted
isDeleted boolean
Соединения
joins array of TableJoin
logo
logo string
имя
name string
publicId
publicId uuid
type
type string
обновлено
updatedAt date-time

SimpleProcess

Имя Путь Тип Описание
allowComments
allowComments boolean
allowDuplication
allowDuplication boolean
children
children array of ProcessSection
createdAt
createdAt date-time
deletedAt
deletedAt date-time
описание
description
expandByDefault
expandByDefault boolean
isDeleted
isDeleted boolean
isTemplate
isTemplate boolean
logo
logo string
имя
name string
publicId
publicId uuid
templateCategory
templateCategory string
type
type string
обновлено
updatedAt date-time
variableValues
variableValues array of string
variables
variables array of string

SimpleProject

Имя Путь Тип Описание
adminLimit
adminLimit integer
automationLimit
automationLimit integer
createdAt
createdAt date-time
defaultProcessId
defaultProcessId string
deletedAt
deletedAt date-time
заголовокStyles
headingStyles array of HeadingStyle
hideProcessCreated
hideProcessCreated boolean
image
image string
isDeleted
isDeleted boolean
logo
logo string
mfaRequired
mfaRequired boolean
имя
name string
noOfAdmins
noOfAdmins integer
primaryColour
primaryColour string
processTitleBold
processTitleBold boolean
processTitleColour
processTitleColour string
processTitleFontSize
processTitleFontSize number
processTitleItalic
processTitleItalic boolean
processTitleUnderline
processTitleUnderline boolean
projectList
projectList array of ProjectList
общественный
public boolean
publicId
publicId string
обновлено
updatedAt date-time

Сортировать

Имя Путь Тип Описание
columnId
columnId uuid
columnName
columnName string
направление
direction string

СводкаUser

Имя Путь Тип Описание
электронная почта
email string
firebaseUserId
firebaseUserId string
имя
name string
profilePicture
profilePicture string
publicId
publicId uuid

Таблица

Имя Путь Тип Описание
allowDuplication
allowDuplication boolean
columns
columns array of TableColumn
createdAt
createdAt date-time
defaultViewId
defaultViewId string
deletedAt
deletedAt date-time
isAconexSynced
isAconexSynced boolean
isAutodeskBim360Synced
isAutodeskBim360Synced boolean
isDeleted
isDeleted boolean
isMortaProjectsSynced
isMortaProjectsSynced boolean
isMortaResourcesSynced
isMortaResourcesSynced boolean
isMortaSynced
isMortaSynced boolean
isMortaUsersSynced
isMortaUsersSynced boolean
isProcoreSynced
isProcoreSynced boolean
isReviztoIssuesSynced
isReviztoIssuesSynced boolean
isSynced
isSynced boolean
isViewpointSynced
isViewpointSynced boolean
Соединения
joins array of TableJoin
keepColoursInSync
keepColoursInSync boolean
keepValidationsInSync
keepValidationsInSync boolean
lastSync
lastSync date-time
logo
logo string
имя
name string
projects
projects array of Project
publicId
publicId uuid
syncHourlyFrequency
syncHourlyFrequency integer
type
type string
обновлено
updatedAt date-time
variables
variables array of string

Таблица1

Имя Путь Тип Описание
defaultViewId
defaultViewId string
имя
name string
publicId
publicId uuid

Таблица2

Имя Путь Тип Описание
createdAt
createdAt date-time
имя
name string
publicId
publicId uuid
type
type string
обновлено
updatedAt date-time

Таблица3

Имя Путь Тип Описание
имя
name string
publicId
publicId uuid

TableColumn

Имя Путь Тип Описание
aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
kindOptions
kindOptions SelectOptionsLookup
mortaSynced
mortaSynced integer
имя
name string
procoreSynced
procoreSynced integer
publicId
publicId uuid
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
thousandSeparator
thousandSeparator boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

TableColumnAggregationResult

Имя Путь Тип Описание
имя
name string
value
value number

TableColumnJoin

Имя Путь Тип Описание
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string

TableColumnWithAggregation

Имя Путь Тип Описание
агрегация
aggregation TableColumnAggregationResult
имя
name string
publicId
publicId uuid

TableJoin

Имя Путь Тип Описание
dataColumns
dataColumns array of TableJoinImportedColumns
isOneToMany
isOneToMany boolean
joinColumns
joinColumns array of TableColumnJoin
joinTableId
joinTableId string
joinViewId
joinViewId string
publicId
publicId uuid

TableJoinImportedColumns

Имя Путь Тип Описание
sourceColumnId
sourceColumnId string
targetColumnId
targetColumnId string

Табличное представление

Имя Путь Тип Описание
allowContributorDelete
allowContributorDelete boolean
chartSettings
chartSettings Chart
свернутыйGroupView
collapsedGroupView boolean
цветаSettings
colourSettings array of Colour
columns
columns array of TableViewColumn
описание
description Draftjs
disableNewRow
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
filterSettings
filterSettings array of Filter
frozenIndex
frozenIndex integer
groupSettings
groupSettings array of Group
isDefault
isDefault boolean
имя
name string
publicId
publicId uuid
rowHeight
rowHeight integer
sortSettings
sortSettings array of Sort
type
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

TableViewColumn

Имя Путь Тип Описание
aconexSynced
aconexSynced integer
aggregate
aggregate integer
alterOptions
alterOptions
autodeskBim360Synced
autodeskBim360Synced integer
dateFormat
dateFormat string
decimalPlaces
decimalPlaces integer
описание
description
hardValidation
hardValidation boolean
isIndexed
isIndexed boolean
IsJoined
isJoined boolean
добрый
kind string
kindOptions
kindOptions SelectOptionsLookup
locked
locked boolean
mortaSynced
mortaSynced integer
имя
name string
procoreSynced
procoreSynced integer
publicId
publicId uuid
required
required boolean
reviztoIssuesSynced
reviztoIssuesSynced integer
script
script string
scriptEnabled
scriptEnabled boolean
sortOrder
sortOrder number
stringValidation
stringValidation string
thousandSeparator
thousandSeparator boolean
validationMessage
validationMessage string
validationNoBlanks
validationNoBlanks boolean
validationNoDuplicates
validationNoDuplicates boolean
viewpointSynced
viewpointSynced integer
Ширина
width integer

TableViewWithTable

Имя Путь Тип Описание
allowContributorDelete
allowContributorDelete boolean
chartSettings
chartSettings Chart
свернутыйGroupView
collapsedGroupView boolean
цветаSettings
colourSettings array of Colour
columns
columns array of TableViewColumn
описание
description Draftjs
disableNewRow
disableNewRow boolean
displayCommentRows
displayCommentRows integer
displayValidationErrorRows
displayValidationErrorRows integer
documentTable
documentTable Table2
filterSettings
filterSettings array of Filter
frozenIndex
frozenIndex integer
groupSettings
groupSettings array of Group
isDefault
isDefault boolean
имя
name string
publicId
publicId uuid
rowHeight
rowHeight integer
sortSettings
sortSettings array of Sort
type
type integer
unpackMultiselectGroupView
unpackMultiselectGroupView boolean

Тег

Имя Путь Тип Описание
documentTableId
documentTableId string
projectPublicId
projectPublicId uuid
publicId
publicId uuid
referencePublicId
referencePublicId string
value
value

Триггер

Имя Путь Тип Описание
publicId
publicId uuid
resource
resource string
глагол
verb string

User

Имя Путь Тип Описание
aconexConnected
aconexConnected boolean
apiKeys
apiKeys array of ApiKey
autodeskConnected
autodeskConnected boolean
био
bio string
constructionSoftware
constructionSoftware array of string
электронная почта
email string
firebaseUserId
firebaseUserId string
добрый
kind string
linkedin
linkedin string
location
location string
имя
name string
организация
organisation string
phone
phone string
procoreConnected
procoreConnected boolean
profilePicture
profilePicture string
projectsWorkedOn
projectsWorkedOn array of string
publicId
publicId uuid
reviztoConnected
reviztoConnected boolean
подпись
signature string
специализмы
specialisms array of string
tags
tags
твиттер
twitter string
университет
university string
universityDegree
universityDegree string
viewpointConnected
viewpointConnected boolean
веб-сайт
website string

Пользователь_1

Имя Путь Тип Описание
имя
name string

Пользователь_2

Имя Путь Тип Описание
электронная почта
email string
firebaseUserId
firebaseUserId string
добрый
kind string
имя
name string
profilePicture
profilePicture string
publicId
publicId uuid
tags
tags

User3

Имя Путь Тип Описание
firebaseUserId
firebaseUserId string
имя
name string
publicId
publicId uuid

User4

Имя Путь Тип Описание
электронная почта
email string
firebaseUserId
firebaseUserId string
добрый
kind string
имя
name string
publicId
publicId uuid

UserWithToken

Имя Путь Тип Описание
aconexConnected
aconexConnected boolean
apiKeys
apiKeys array of ApiKey
authToken
authToken string
autodeskConnected
autodeskConnected boolean
био
bio string
constructionSoftware
constructionSoftware array of string
электронная почта
email string
firebaseUserId
firebaseUserId string
hasPassword
hasPassword
id
id integer
is2FaEnabled
is2FaEnabled
isSuperAdmin
isSuperAdmin boolean
добрый
kind string
lastLoginAt
lastLoginAt date-time
linkedin
linkedin string
location
location string
имя
name string
организация
organisation string
phone
phone string
procoreConnected
procoreConnected boolean
profilePicture
profilePicture string
projectsWorkedOn
projectsWorkedOn array of string
publicId
publicId uuid
reviztoConnected
reviztoConnected boolean
подпись
signature string
специализмы
specialisms array of string
tags
tags
твиттер
twitter string
университет
university string
universityDegree
universityDegree string
viewpointConnected
viewpointConnected boolean
веб-сайт
website string

бинарный

Это базовый тип данных binary.