Finalcad One Connect 4.0 (предварительная версия)

Finalcad One — это платформа управления строительством, предназначенная для улучшения совместной работы, отслеживания хода выполнения и упрощения операций с полями. С помощью этого соединителя вы можете интегрировать Finalcad One с сотнями других приложений, чтобы упростить отслеживание проектов, автоматизировать повторяющиеся задачи и повысить общую эффективность.

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

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: - Azure Government регионы - Azure регионы Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate за исключением следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Finalcad
URL	https://www.finalcad.com/contact
Адрес электронной почты	support@finalcad.com

Метаданные соединителя
Publisher	FINALCAD
Веб-сайт	https://developer.finalcad.com/
Политика конфиденциальности	https://www.finalcad.com/apps-privacy-policy
Категории	Продуктивность

Соединитель Fc1

Предпосылки

To use this connector, you need a Finalcad API key.

Triggers

When a form is created or updated
When an observation is created or updated
When a document is created

Действия

Read form details
Read observation details
Read project information
Read current user information

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

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


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

По умолчанию

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

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

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

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

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

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

Действия

Media — получение URL-адреса ресурса мультимедиа	Получение URL-адреса для доступа к ресурсу мультимедиа
Project — добавление пользователей	Добавление пользователей в проект
Project — получение категорий форм	Получение категорий форм
Project — получение компаний	Получение компаний в проекте
Project — получение модулей формы	Получение списка всех существующих модулей форм для данного проекта
Project — получение папок документов	Получение папок документов в проекте
Project — получение пользователей	Получение пользователей в проекте
Project — получение приоритетов форм	Получение приоритетов форм в проекте
Project — получение ролей	Получение ролей проекта
Project — получение сведений о проекте	Получение сведений о заданном проекте (часовой пояс, язык, дата обновления,...)
Настройка — Проект	Настройка конфигурации проекта
Настройка — язык и часовой пояс	Настройка конфигурации языка и часового пояса
Носитель — добавление части блока	Добавьте отдельный фрагмент в текущий сеанс отправки мультимедиа.
Носитель — запуск отправки блока	Инициируйте процесс отправки файла мультимедиа в блоках.
Носитель — отправка блока прерывания	Отмените текущий процесс отправки блоков и удалите все полученные части.
Носитель — проверка отправки блока	Подтвердите и завершите отправку, убедившись, что все блоки были получены правильно.
Организация — добавление участников	Добавление участников в организацию
Организация — получение подключенного пользователя	Получение сведений о пользователе
Организация — получение предлагаемых модулей	Получение предлагаемых модулей, связанных с вашей организацией
Организация — получение рабочих областей	Получение рабочих областей, связанных с вашей организацией
Организация — получение ролей	Получение ролей организации
Организация — получение состояния форм	Получение состояния форм в шаблоне
Организация — получение списка организаций	Получение списка всех организаций, в которых вы являетесь членом
Организация — получение списка проектов	Получение списка всех проектов в данной организации
Организация — создание проекта	Создание проекта
Получение списка часовых поясов	Получение списка доступных часовых поясов
Получение языков	Получение всех доступных языков для библиотек и элементов
Проект — получение групп обсуждений	Получение групп обсуждений в проекте
Проект — получение документа или папки	Получение документа или папки
Проект — получение категорий наблюдений	Получение категорий наблюдения (ранее торгов)
Проект — получение моделей наблюдения	Получение моделей наблюдения (категория ранее называлась торговлей)
Проект — получение модулей наблюдения	Получение списка всех существующих модулей наблюдения для данного проекта
Проект — получение планов или папок	Получение планов или папок в проекте
Проект — получение приоритетов наблюдений	Получение приоритетов наблюдений в проекте
Проект — получение сведений о наблюдении	Получение сведений о заданном наблюдении (описание, состояние, назначение,...)
Проект — получение сведений о форме	Получение сведений о данной форме (описание, имя шаблона, назначение,...)
Проект — получение состояний наблюдения	Получение состояния наблюдений в проекте
Проект — получение шаблонов форм	Получение шаблонов форм
Проект — создание документа	Проект — создание документа
Проект — создание наблюдения	Создание наблюдения
Проект — создание формы	Создание формы
Проект — этапы получения	Получение этапов проекта
Рабочая область — добавление элементов	Добавление участников в рабочую область

Media — получение URL-адреса ресурса мультимедиа

Идентификатор операции:: GetMediaUrl

Получение URL-адреса для доступа к ресурсу мультимедиа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор носителя	mediaId	True	string	Идентификатор носителя
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: MediaResourceUrl

Project — добавление пользователей

Идентификатор операции:: AddProjectMembers

Добавление пользователей в проект

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Не отправлять сообщения электронной почты пользователям	doNotSendEmail		boolean	Не отправлять сообщения электронной почты пользователям
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Электронная почта пользователя	email	True	string	Электронная почта пользователя
Идентификатор роли пользователя	project_role_id	True	string	Идентификатор роли пользователя

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

Тело: AddMembers

Project — получение категорий форм

Идентификатор операции:: GetModuleCategories

Получение категорий форм

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор модуля	module_id		string	Идентификатор модуля
Идентификатор родительской категории	category_id		string	Идентификатор родительской категории
Включение отключено	with_disabled		string	Включение отключено
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetModulesCategories

Project — получение компаний

Идентификатор операции:: GetProjectCompanies

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Непрерывный маркер	continuous_token		string	Непрерывный маркер
Максимальное количество компаний для получения	limit		integer	Максимальное количество компаний для получения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetCompanies

Project — получение модулей формы

Идентификатор операции:: GetFormsModules

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Континуозный маркер	continuous_token		string	Континуозный маркер
Максимальное количество модулей для получения	limit		integer	Максимальное количество модулей для получения
Включение удаленных	with_deleted		boolean	Включение удаленных
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetModulesForm

Project — получение папок документов

Идентификатор операции:: GetDocuments

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор родительской папки	parent_id		string	Идентификатор родительской папки
Фильтруйте тип контента ÔÇöfolder, "documentÔÇÖ или ничего".	type		string	Фильтруйте тип контента ÔÇöfolder, "documentÔÇÖ или ничего".
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetDocumentsFiltered

Project — получение пользователей

Идентификатор операции:: GetProjectMembers

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Непрерывный маркер	continuous_token		string	Непрерывный маркер
Максимальное количество элементов для извлечения	limit		integer	Максимальное количество элементов для извлечения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetMembers

Project — получение приоритетов форм

Идентификатор операции:: GetFormPriorities

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Непрерывный маркер	continuous_token		string	Непрерывный маркер
Максимальное число приоритетов для получения	limit		integer	Максимальное число приоритетов для получения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetPriorities

Project — получение ролей

Идентификатор операции:: GetProjectRoles

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор проекта	projectId	True	string	Идентификатор проекта
Максимальное количество ролей проекта для получения	limit		string	Максимальное количество ролей проекта для получения
Роль Nth	offset		string	Роль Nth
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetProjectRoles

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

Идентификатор операции:: GetProjectDetail

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetProject

Настройка — Проект

Идентификатор операции:: Init

Настройка конфигурации проекта

Параметры

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

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

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

Настройка — язык и часовой пояс

Идентификатор операции:: InitParameters

Настройка конфигурации языка и часового пояса

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	language		string	Language
Часовой пояс	timezone		string	Часовой пояс пользователя (в формате IANA)

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

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

Носитель — добавление части блока

Идентификатор операции:: MediaUploadChunk

Добавьте отдельный фрагмент в текущий сеанс отправки мультимедиа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор носителя	mediaId	True	string	Идентификатор носителя
Language	Accept-Language		string	Language
Идентификатор блока	chunk_id	True	string	Идентификатор блока
Номер сегмента	segment_index	True	integer	Номер блока
Последний звонок?	last_chunk		boolean	Последний звонок?
filename	filename	True	string
Тип контента	contentType	True	string
содержимое	content	True	byte

Носитель — запуск отправки блока

Идентификатор операции:: MediaUploadInit

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Имя файла мультимедиа	file_name	True	string	Имя файла мультимедиа
Общий размер носителя в байтах	total_bytes	True	integer	Общий размер мультимедиа в байтах
Media MD5	md5		string	Media MD5

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

Тело: UploadChunkInit

Носитель — отправка блока прерывания

Идентификатор операции:: MediaUploadAbort

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор носителя	mediaId	True	string	Идентификатор носителя
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор блока	chunk_id	True	string	Идентификатор блока

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

Тело: Media

Носитель — проверка отправки блока

Идентификатор операции:: MediaUploadValidate

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор носителя	mediaId	True	string	Идентификатор носителя
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор блока	chunk_id	True	string	Идентификатор блока

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

Тело: Media

Организация — добавление участников

Идентификатор операции:: AddOrgaMembers

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор роли	role_id		string	Идентификатор роли
Электронная почта пользователей	users_info		array of string	электронная почта пользователей

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

Идентификатор операции:: GetUserDetail

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetUserInfo

Организация — получение предлагаемых модулей

Идентификатор операции:: GetModuleSuggestions

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Идентификатор рабочей области	workspace_id		string	Идентификатор рабочей области
Максимальное количество модулей	limit		string	Максимальное количество модулей
Модуль Nth	offset		string	Модуль Nth
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetModulesOrgaSuggestion

Организация — получение рабочих областей

Идентификатор операции:: GetWorkspaces

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Идентификатор родительской рабочей области	parent_id		string	Идентификатор родительской рабочей области
Включение дочерних элементов	with_children		string	Включение дочерних элементов
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetWorkspaces

Организация — получение ролей

Идентификатор операции:: GetOrgaRoles

Получение ролей организации

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetRoles

Организация — получение состояния форм

Идентификатор операции:: GetFormTemplateStatuses

Получение состояния форм в шаблоне

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Идентификатор шаблона формы	formId	True	string	Идентификатор шаблона формы
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetFormStatuses

Организация — получение списка организаций

Идентификатор операции:: GetOrganizations

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Имя	Путь	Тип	Описание
		array of object
id	id	string	id
имя	name	string	имя

Организация — получение списка проектов

Идентификатор операции:: GetProjects

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Идентификатор рабочей области	workspace_id		string	Идентификатор рабочей области
Включение дочерних рабочих областей	with_workspace_children		boolean	Включение дочерних рабочих областей
Условие поиска	search_term		string	Условие поиска
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetProjects

Организация — создание проекта

Идентификатор операции:: AddProject

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Имя проекта	name	True	string	Имя проекта
Идентификатор рабочей области Project	workspace_id		string	Идентификатор рабочей области Project
Идентификаторы модулей project	module_ids		array of string	Идентификаторы модулей project
Описание проекта	description		string	Описание проекта
Язык проекта	language		string	Язык проекта
Часовой пояс проекта	time_zone		string	Часовой пояс проекта
Справочник по проекту	case_number		string	Справочник по проекту
Адрес проекта	address		string	Адрес проекта
Дата окончания проекта	end_date		string	Дата окончания проекта

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

Тело: CreateProject

Получение списка часовых поясов

Идентификатор операции:: GetTimezonesList

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

Параметры

Имя	Ключ	Тип	Описание
Максимальное число часовых поясов для получения.	limit	string	Максимальное число часовых поясов для получения.
Часовой пояс Nth.	offset	string	Часовой пояс Nth.
Language	Accept-Language	string	Language
TimeZone	X-TimeZone	string	TimeZone

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

Тело: GetTimeZones

Получение языков

Идентификатор операции:: GetLanguagesList

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetLanguages

Проект — получение групп обсуждений

Идентификатор операции:: GetProjectGroups

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Максимальное количество групп обсуждений для получения	limit		integer	Максимальное количество групп обсуждений для получения
Группа обсуждений nth, из которой я хочу получить группы обсуждений	offset		integer	Группа обсуждений nth, из которой я хочу получить группы обсуждений
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetGroups

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

Идентификатор операции:: GetDocumentDetail

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор документа	documentId	True	string	Идентификатор документа
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: Document

Проект — получение категорий наблюдений

Идентификатор операции:: GetTradesModules

Получение категорий наблюдения (ранее торгов)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор модуля	module_id		string	Идентификатор модуля
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetTradesByModule

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

Идентификатор операции:: GetCommonobsTrade

Получение моделей наблюдения (категория ранее называлась торговлей)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор категории	tradeId	True	string	Идентификатор категории
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetCommonObsByTrade

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

Идентификатор операции:: GetObservationsModules

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Континуозный маркер	continuous_token		string	Континуозный маркер
Максимальное число модулей для получения	limit		integer	Максимальное число модулей для получения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetModules

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

Идентификатор операции:: GetFolderContent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор папки	folder_id		string	Идентификатор папки
Включить только планы или папки	type		string	Включить только планы или папки
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetFolderContent

Проект — получение приоритетов наблюдений

Идентификатор операции:: GetObservationPriorities

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Непрерывный маркер	continuous_token		string	Непрерывный маркер
Приоритет Nth	offset		string	Приоритет Nth
Максимальное число приоритетов od для получения	limit		integer	Максимальное число приоритетов od для получения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetPriorities

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

Идентификатор операции:: GetObservationDetail

Получение сведений о заданном наблюдении (описание, состояние, назначение,...)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор наблюдения	observationId	True	string	Идентификатор наблюдения
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetObservationFull

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

Идентификатор операции:: GetFormDetail

Получение сведений о данной форме (описание, имя шаблона, назначение,...)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор формы	formId	True	string	Идентификатор формы
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetFormFull

Проект — получение состояний наблюдения

Идентификатор операции:: GetObservationStatuses

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Непрерывный маркер	continuous_token		string	Непрерывный маркер
Максимальное число извлекаемых состояний	limit		integer	Максимальное число извлекаемых состояний
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetStatuses

Проект — получение шаблонов форм

Идентификатор операции:: GetFormTemplates

Получение шаблонов форм

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Идентификатор модуля	module_id		string	Идентификатор модуля
Идентификатор категории	category_id		string	Идентификатор категории
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetForms

Проект — создание документа

Идентификатор операции:: CreateDocument

Проект — создание документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Имя документа	name	True	string	Имя документа
Идентификатор родительского документа	parent_id		string	Идентификатор родительской папки
Идентификатор носителя документа	media_id		string	Если поле не заполнено, будет создана папка

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

Тело: CreateDocument

Проект — создание наблюдения

Идентификатор операции:: CreateObservation

Создание наблюдения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор модуля наблюдения	module_id	True	string	Идентификатор модуля наблюдения
Идентификатор категории наблюдения	trade_id		string	Категория ранее называлась торговлей
Идентификатор модели наблюдения	common_observation_id		string	Модель ранее называлась общим наблюдением
Описание наблюдения	description		string	Описание наблюдения
Идентификатор состояния наблюдения	status_id		string	Идентификатор состояния наблюдения
Идентификатор компании наблюдения	company_id		string	Идентификатор назначенной компании наблюдения
Идентификатор назначаемого наблюдателя	assignee_id		string	Идентификатор назначенного пользователем наблюдения
Идентификатор плана наблюдения	plan_id		string	Идентификатор плана наблюдения
Наблюдение за положением X по плану	position_x		decimal	Позиция X в диапазоне от 0 до 1
Позиция наблюдения Y по плану	position_y		decimal	Позиция наблюдения Y от 0 до 1
Идентификатор приоритета наблюдения	priority_id		string	Идентификатор приоритета наблюдения
Дата выполнения наблюдения	due_date		string	Дата выполнения наблюдения
Идентификатор этапа наблюдения	phase_id		string	Идентификатор этапа наблюдения
Идентификатор группы обсуждений наблюдения	group_id		string	Группа обсуждений, в которой следует поделиться наблюдением после ее создания
Наблюдение широты	latitude		decimal	Широта наблюдения
Наблюдение за долготой	longitude		decimal	Смотровая долготу
Идентификатор наблюдения	id		string	Идентификатор наблюдения

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

Тело: CreateObservation

Проект — создание формы

Идентификатор операции:: CreateForm

Создание формы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор модуля формы	module_id	True	string	Идентификатор модуля формы
Шаблон формы	form_id	True	string	Идентификатор шаблона формы
Имя формы	name	True	string	Имя формы
Идентификатор категории формы	category_id		string	Идентификатор категории формы
Идентификатор состояния формы	status_id		string	Идентификатор состояния формы
Идентификатор компании формы	company_id		string	Идентификатор назначенной организации в форме
Идентификатор назначаемого формы	assignee_id		string	Идентификатор назначаемого пользователем формы
Идентификатор плана формы	plan_id		string	Идентификатор плана формы
Позиция Form X	position_x		decimal	Позиция формы X по плану от 0 до 1
Позиция формы Y	position_y		decimal	Позиция формы Y по плану от 0 до 1
Широта формы	latitude		decimal	Широта формы
Долгота формы	longitude		decimal	Долгота формы
Идентификатор приоритета формы	priority_id		string	Идентификатор приоритета формы
Дата выполнения формы	due_date		string	Дата выполнения формы
Идентификатор этапа формы	phase_id		string	Идентификатор этапа формы
Идентификатор формы	id		string	Идентификатор формы

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

Тело: CreateFormInstance

Проект — этапы получения

Идентификатор операции:: GetProjectPhases

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Код проекта	projectId	True	string	Код проекта
Континуозный маркер	continuous_token		string	Континуозный маркер
Этап Nth	offset		string	Этап Nth
Максимальное количество этапов для получения	limit		integer	Максимальное количество этапов для получения
Включение удаленных	with_deleted		boolean	Включение удаленных
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone

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

Тело: GetPhases

Рабочая область — добавление элементов

Идентификатор операции:: AddWSMembers

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор организации	organizationId	True	string	Идентификатор организации
Идентификатор рабочей области	workspaceId	True	string	Идентификатор рабочей области
Language	Accept-Language		string	Language
TimeZone	X-TimeZone		string	TimeZone
Идентификатор пользователя	user_id		string	Идентификатор пользователя
Электронная почта пользователя	user_email		string	Электронная почта пользователя

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

Тело: GetWorkspaceMembers

Триггеры

Триггер — обновлена форма	Активация потока при обновлении формы
Триггер — обновление наблюдения	Активация потока при обновлении наблюдения
Триггер — создан документ	Активация потока при создании документа
Триггер — созданная форма	Активация потока при создании формы
Триггер — создано наблюдение	Активация потока при создании наблюдения

Триггер — обновлена форма

Идентификатор операции:: ThenFormUpdated

Активация потока при обновлении формы

Параметры

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

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

Имя	Путь	Тип	Описание
parent_id	parent_id	string	parent_id
событие	event	integer	событие
element_id	element_id	string	element_id
data1	data1	string	data1
data2	data2	string	data2
data3	data3	string	data3

Триггер — обновление наблюдения

Идентификатор операции:: ThenObsUpdated

Активация потока при обновлении наблюдения

Параметры

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

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

Имя	Путь	Тип	Описание
parent_id	parent_id	string	parent_id
событие	event	integer	событие
element_id	element_id	string	element_id
data1	data1	string	data1
data2	data2	string	data2
data3	data3	string	data3

Триггер — создан документ

Идентификатор операции:: ThenDocumentCreated

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

Параметры

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

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

Имя	Путь	Тип	Описание
parent_id	parent_id	string	parent_id
событие	event	integer	событие
element_id	element_id	string	element_id
data1	data1	string	data1
data2	data2	string	data2
data3	data3	string	data3

Триггер — созданная форма

Идентификатор операции:: ThenFormCreated

Активация потока при создании формы

Параметры

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

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

Имя	Путь	Тип	Описание
parent_id	parent_id	string	parent_id
событие	event	integer	событие
element_id	element_id	string	element_id
data1	data1	string	data1
data2	data2	string	data2
data3	data3	string	data3

Триггер — создано наблюдение

Идентификатор операции:: ThenObsCreated

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

Параметры

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

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

Имя	Путь	Тип	Описание
parent_id	parent_id	string	parent_id
событие	event	integer	событие
element_id	element_id	string	element_id
data1	data1	string	data1
data2	data2	string	data2
data3	data3	string	data3

Определения

AddMembers

Имя	Путь	Тип	Описание
Список пользователей	project_roles	array of ProjectRole	Список пользователей

Компания

Имя	Путь	Тип	Описание
Идентификатор компании	id	string	Идентификатор компании
Название компании	name	string	Название компании
Компания включена	enabled	boolean	Компания включена
Члены компании	user_ids	array of string	Члены компании
Справочник по компании	reference	string	Справочник по компании
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

CreateDocument

Имя	Путь	Тип	Описание
Идентификатор документа	id	string	Идентификатор документа
Тип документа	type	string	Тип документа
Имя документа	name	string	Имя документа
Идентификатор родительской папки документа	parent_id	string	Идентификатор родительской папки документа
media_resource	media_resource	Media
Документ включен	enabled	boolean	Документ включен
Тип документа	file_type	string	Тип документа
Источник документа	item_source	string	Источник документа
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

CreateFormInstance

Имя	Путь	Тип	Описание
Идентификатор формы	id	string	Идентификатор формы
Имя формы	name	string	Имя формы
Идентификатор шаблона формы	form_id	string	Идентификатор шаблона формы
Идентификатор состояния формы	status_id	string	Идентификатор состояния формы
Идентификатор приоритета формы	priority_id	string	Идентификатор приоритета формы
Идентификатор плана формы	plan_id	string	Идентификатор плана формы
Позиция Form X	position_x	decimal	Позиция Form X
Позиция формы Y	position_y	decimal	Позиция формы Y
Широта формы	latitude	decimal	Широта формы
Долгота формы	longitude	decimal	Долгота формы
Идентификатор пользователя формы	assignee_id	string	Идентификатор назначаемого пользователем формы
Идентификатор организации формы	company_id	string	Идентификатор назначенной организации в форме
Дата выполнения формы	due_date	string	Дата выполнения формы
Дата создания формы	client_created_at	string	Идентификатор создания формы
Дата обновления формы	client_updated_at	string	Идентификатор обновления формы
Идентификатор модуля формы	module_id	string	Идентификатор модуля формы
Идентификатор этапа формы	phase_id	string	Идентификатор этапа формы
Идентификатор категории формы	category_id	string	Идентификатор категории формы
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

CreateObservation

Имя	Путь	Тип	Описание
id	id	string
project_id	project_id	string
описание	description	string
status_id	status_id	string
priority_id	priority_id	string
plan_id	plan_id	string
position_x	position_x	decimal
position_y	position_y	decimal
широта	latitude	decimal
долгота	longitude	decimal
assignee_id	assignee_id	string
company_id	company_id	string
trade_id	trade_id	string
common_observation_id	common_observation_id	string
due_date	due_date	string
client_created_at	client_created_at	string
client_updated_at	client_updated_at	string
module_id	module_id	string
phase_id	phase_id	string
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

CreateProject

Имя	Путь	Тип	Описание
Адрес проекта	address	string	Адрес проекта
Часовой пояс проекта	time_zone	string	Часовой пояс IANA проекта
Язык проекта	language	string	Язык проекта
Код проекта	project_id	string	Код проекта
Идентификатор организации проекта	organization_id	string	Идентификатор организации проекта
Имя проекта	name	string	Имя проекта
Пример проекта	case_number	string	Пример проекта
Идентификатор рабочей области проекта	workspace_id	string	Идентификатор рабочей области проекта
Описание проекта	description	string	Описание проекта
Дата окончания проекта	end_date	string	Дата окончания проекта
Число участников проекта	member_count	integer	Число участников проекта
Проект архивирован	is_archived	boolean	Проект архивирован
media_resource	media_resource	Media
Текущий пользователь в проекте	current_user_in_project	boolean	Текущий пользователь в проекте?
Проект активен	is_active	boolean	Проект активен
Статус проекта	status	string	Статус проекта
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

Документ

Имя	Путь	Тип	Описание
Идентификатор документа	id	string	Идентификатор документа
Тип документа	type	string	Тип документа
Имя документа	name	string	Имя документа
Идентификатор родительской папки документа	parent_id	string	Идентификатор родительской папки документа
media_resource	media_resource	Media
Документ включен	enabled	boolean	Документ включен
Тип документа	file_type	string	Тип документа
Источник документа	item_source	string	Источник документа
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

FolderContent

Имя	Путь	Тип	Описание
Идентификатор содержимого папки	id	string	Идентификатор содержимого папки
Тип содержимого папки	type	string	Тип содержимого папки
Имя содержимого папки	name	string	Имя содержимого папки
Порядок содержимого папки	order	double	Порядок содержимого папки
Дата создания содержимого папки	created_at	string	Дата создания содержимого папки
Дата обновления содержимого папки	updated_at	string	Дата обновления содержимого папки
Источник содержимого папки	source	string	Содержимое папки isourced
Источник папки содержимого папки папки	sources_contained	string	Источник папки содержимого папки папки
Содержимое папки включено	enabled	boolean	Содержимое папки включено

Form

Имя	Путь	Тип	Описание
ИД шаблона	id	string	ИД шаблона
Имя шаблона	name	string	Имя шаблона
Включен шаблон	enabled	boolean	Шаблон включен да/нет
Номер версии шаблона	version	integer	Номер версии шаблона
Идентификатор модуля шаблона	module_id	string	Идентификатор модуля шаблона
Идентификатор категории шаблона	category_id	string	Идентификатор категории шаблона
Дата создания шаблона	created_at	string	Дата создания шаблона
Дата обновления шаблона	updated_at	string	Дата обновления шаблона

GetCommonObsByTrade

Имя	Путь	Тип	Описание
CommonObs	common_observations	array of ObservationCommonObservation	CommonObs

GetCompanies

Имя	Путь	Тип	Описание
Компании	companies	array of Company	Компании
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetDocumentsFiltered

Имя	Путь	Тип	Описание
Документы	documents	array of Document
count	count	integer

GetFolderContent

Имя	Путь	Тип	Описание
Содержимое папки	contents	array of FolderContent	Содержимое папки
count	count	integer

GetFormFull

Имя	Путь	Тип	Описание
Идентификатор формы	id	string	Идентификатор формы
Номер формы	legacy_id	integer	Номер формы
Включена форма	enabled	boolean	Включена форма
Идентификатор шаблона формы	form_id	string	Идентификатор шаблона формы
Идентификатор организации	organization_id	string	Идентификатор организации
Название организации	organization_name	string	Название организации
Идентификатор проекта	project_id	string	Код проекта
Имя проекта	project_name	string	Имя проекта
Описание формы	description	string	Описание формы
Имя шаблона формы	template_name	string	Имя шаблона формы
Идентификатор состояния формы	status_id	string	Идентификатор состояния формы
Имя состояния формы	status_name	string	Имя состояния формы
Идентификатор приоритета формы	priority_id	string	Идентификатор приоритета формы
Имя приоритета формы	priority_name	string	Имя приоритета формы
Идентификатор пользователя формы	assignee_id	string	Идентификатор назначаемого пользователем формы
Имя пользователя формы	assignee_name	string	Имя пользователя, назначаемого формой
Идентификатор организации формы	company_id	string	Идентификатор организации формы
Название организации формы	company_name	string	Имя назначенной организации в форме
Дата выполнения формы	due_date	string	Дата выполнения формы
Идентификатор плана формы	plan_id	string	Идентификатор плана формы
Имя плана формы	plan_name	string	Имя плана формы
Позиция формы X	position_x	string	Позиция Form X
Позиция формы Y	position_y	string	Позиция формы Y
Широта формы	latitude	string	Широта формы
Долгота формы	longitude	string	Долгота формы
Идентификатор модуля формы	module_id	string	Идентификатор модуля формы
Имя модуля формы	module_name	string	Имя модуля формы
Идентификатор этапа формы	phase_id	string	Идентификатор этапа формы
Имя этапа формы	phase_name	string	Имя этапа формы
Идентификатор категории формы	category_id	string	Идентификатор категории формы
Имя категории формы	category_name	string	Имя категории формы
Дата удаления формы	deleted_at	string	Дата удаления формы
Форма удалена	deleted_by	string	Форма удалена идентификатором пользователя
Дата создания формы	client_created_at	string	Дата создания формы
Дата обновления формы	client_updated_at	string	Дата обновления формы
URL-адрес формы	web_url	string	URL-адрес формы
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

GetFormStatuses

Имя	Путь	Тип	Описание
Статусы	statuses	array of StatusResponseWithoutLanguage	Статусы
count	count	integer

GetForms

Имя	Путь	Тип	Описание
Список шаблонов	forms	array of Form	Список шаблонов
count	count	integer

GetGroup

Имя	Путь	Тип	Описание
Идентификатор группы	id	string	Идентификатор группы
Имя группы	name	string	Имя группы

GetGroups

Имя	Путь	Тип	Описание
Groups	groups	array of GetGroup	Groups
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetLanguage

Имя	Путь	Тип	Описание
Код языка	code	string	Код языка
Описание языка	name	string	Описание языка

GetLanguages

Имя	Путь	Тип	Описание
Список языков	langs	array of GetLanguage	Список языков
Число языков	count	integer	Число языков

GetMembers

Имя	Путь	Тип	Описание
Члены проекта	project_members	array of Member	Члены проекта
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetModules

Имя	Путь	Тип	Описание
Список модулей	modules	array of Module	список модулей проекта
need_to_relaunch	need_to_relaunch	boolean
continuous_token	continuous_token	string
offset	offset	string
count	count	integer

Категории GetModules

Имя	Путь	Тип	Описание
Категории	categories	array of ModuleCategory	Категории
count	count	integer

GetModulesForm

Имя	Путь	Тип	Описание
Список модулей	modules	array of ModuleForm	Список модулей
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetModulesOrgaSuggestion

Имя	Путь	Тип	Описание
Suggestions	suggestions	array of ModuleOrgaSuggestion	Suggestions
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetObservationFull

Имя	Путь	Тип	Описание
Идентификатор наблюдения	id	string	Идентификатор наблюдения
Число наблюдения	legacy_id	integer	Число наблюдения
Наблюдение включено	enabled	boolean	Наблюдение включено
Идентификатор проекта наблюдения	project_id	string	Идентификатор проекта наблюдения
Имя проекта наблюдения	project_name	string	Имя проекта наблюдения
Идентификатор организации наблюдения	organization_id	string	Идентификатор организации наблюдения
Имя организации наблюдения	organization_name	string	Имя организации наблюдения
Описание наблюдения	description	string	Описание наблюдения
Идентификатор состояния наблюдения	status_id	string	Идентификатор состояния наблюдения
Имя состояния наблюдения	status_name	string	Имя состояния наблюдения
Идентификатор приоритета наблюдения	priority_id	string	Идентификатор приоритета наблюдения
Имя приоритета наблюдения	priority_name	string	Имя приоритета наблюдения
Идентификатор плана наблюдения	plan_id	string	Идентификатор плана наблюдения
Имя плана наблюдения	plan_name	string	Имя плана наблюдения
Позиция "Наблюдение X"	position_x	decimal	Позиция "Наблюдение X"
Позиция наблюдения Y	position_y	decimal	Позиция наблюдения Y
Широта наблюдения	latitude	decimal	Широта наблюдения
Смотровая долготу	longitude	decimal	Смотровая долготу
Идентификатор пользователя наблюдения	assignee_id	string	Идентификатор назначенного пользователем наблюдения
Имя пользователя наблюдения	assignee_name	string	Имя пользователя, назначенное наблюдением
Идентификатор компании наблюдения	company_id	string	Идентификатор назначенной компании наблюдения
Название компании наблюдения	company_name	string	Имя назначенной компании наблюдения
Идентификатор торговой торговли наблюдения	trade_id	string	Идентификатор торговой торговли наблюдения
Имя торговых наблюдений	trade_name	string	Имя торговых наблюдений
Идентификатор commonobs для наблюдения	common_observation_id	string	Общий идентификатор наблюдения
Имя общих объектов наблюдения	common_observation_name	string	Общее имя наблюдения
Дата выполнения наблюдения	due_date	string	Дата выполнения наблюдения
Идентификатор модуля наблюдения	module_id	string	Идентификатор модуля наблюдения
Имя модуля наблюдения	module_name	string	Имя модуля наблюдения
deleted_at	deleted_at	string
deleted_by	deleted_by	string
Идентификатор этапа наблюдения	phase_id	string	Идентификатор этапа наблюдения
Имя этапа наблюдения	phase_name	string	Имя этапа наблюдения
Изображения наблюдения	photos	array of ObservationMediaResource	Изображения наблюдения
Дата создания наблюдения	client_created_at	string	Дата создания наблюдения
Дата обновления наблюдения	client_updated_at	string	Дата обновления наблюдения
URL-адрес наблюдения	web_url	string	URL-адрес наблюдения
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

GetPhases

Имя	Путь	Тип	Описание
Этапы	phases	array of Phase	Этапы
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetPriorities

Имя	Путь	Тип	Описание
Приоритеты	priorities	array of Priority	Приоритеты
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetProject

Имя	Путь	Тип	Описание
Адрес проекта	address	string	Адрес проекта
Часовой пояс проекта	time_zone	string	Часовой пояс IANA проекта
Язык проекта	language	string	Язык проекта
Код проекта	project_id	string	Код проекта
Идентификатор организации проекта	organization_id	string	Идентификатор организации проекта
Имя проекта	name	string	Имя проекта
Пример проекта	case_number	string	Пример проекта
Идентификатор рабочей области проекта	workspace_id	string	Идентификатор рабочей области проекта
Описание проекта	description	string	Описание проекта
Дата окончания проекта	end_date	string	Дата окончания проекта
Число участников проекта	member_count	integer	Число участников проекта
Проект архивирован	is_archived	boolean	Проект архивирован
media_resource	media_resource	Media
Текущий пользователь в проекте	current_user_in_project	boolean	Текущий пользователь в проекте?
Проект активен	is_active	boolean	Проект активен
Статус проекта	status	string	Статус проекта
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

GetProjectRoles

Имя	Путь	Тип
project_roles	project_roles	array of ProjectRole
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetProjects

Имя	Путь	Тип	Описание
Список проектов	projects	array of Project	Список проектов
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetRole

Имя	Путь	Тип	Описание
Идентификатор роли	id	string	Идентификатор роли
Имя роли	name	string	Имя роли
Описание роли	description	string	Описание роли
names	names	LocalizedLabelFallback
Описания	descriptions	LocalizedLabelFallback
Роль по умолчанию	is_default	boolean	Роль по умолчанию
is_default_invitation_role	is_default_invitation_role	boolean
user_count	user_count	integer
позиция	position	integer
authorization_role_id	authorization_role_id	string
higher_role_id	higher_role_id	string
is_lower_role	is_lower_role	boolean

GetRoles

Имя	Путь	Тип	Описание
organization_roles	organization_roles	array of GetRole

GetStatuses

Имя	Путь	Тип	Описание
Статусы	statuses	array of StatusResponseWithoutFlow	Статусы
Список является некомпетентным	need_to_relaunch	boolean	Список является некомпетентным
Непрерывный маркер	continuous_token	string	Маркер для получения следующих элементов
Количество элементов	count	integer	Количество элементов
Общее число элементов	total_count	integer	Общее число элементов

GetTimeZones

Имя	Путь	Тип	Описание
Список часовых поясов	time_zones	array of TimeZones	Список часовых поясов
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetTradesByModule

Имя	Путь	Тип	Описание
Специализации	trades	array of ProjectTrade	Специализации

GetUserInfo

Имя	Путь	Тип	Описание
Идентификатор пользователя	id	string	Идентификатор пользователя
Имя пользователя	first_name	string	Имя пользователя
Фамилия пользователя	last_name	string	Фамилия пользователя
Адрес электронной почты пользователя	email	string	Адрес электронной почты пользователя
Имя организации пользователя	company	string	Имя организации пользователя
активен	is_active	string	активен
email_validated	email_validated	string
Дата создания пользователя	created_at	string	Дата создания пользователя
updated_at	updated_at	string
deleted_at	deleted_at	string
media_resource	media_resource	Media
Языковой стандарт пользователя	locale	string	Языковой стандарт пользователя

GetWorkspaceMembers

Имя	Путь	Тип
workspace_members	workspace_members	array of OrgaMemberResponses
count	count	integer
total_count	total_count	integer
limit	limit	integer
offset	offset	integer

GetWorkspaces

Имя	Путь	Тип	Описание
Пространства для работы	workspaces	array of Workspace	Пространства для работы

IconTypeParameters

: string

Локализованнаяlabel

Имя	Путь	Тип	Описание
language	language	string
перевод	translation	string

LocalizedLabelFallback

Имя	Путь	Тип	Описание
translation_fallback	translation_fallback	string
Переводы	translations	array of LocalizedLabel

Средства массовой информации

Имя	Путь	Тип	Описание
Идентификатор носителя	id	string	Идентификатор носителя
Имя файла мультимедиа	file_name	string	Имя файла мультимедиа
Тип MIME мультимедиа	mime_type	string	Тип MIME мультимедиа
Дата создания мультимедиа	created_at	string	Дата создания мультимедиа

MediaResourceUrl

Имя	Путь	Тип	Описание
URL-адрес мультимедиа	url	string	URL-адрес мультимедиа

Член

Имя	Путь	Тип	Описание
Идентификатор члена	user_id	string	Идентификатор члена
Имя участника	first_name	string	Имя участника
Фамилия участника	last_name	string	Фамилия участника
Электронная почта участника	email	string	Электронная почта участника
Идентификатор роли участника	project_role_id	string	Идентификатор роли участника
картина	picture	Media
Участник включен	enabled	boolean	Участник включен
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

Модуль

Имя	Путь	Тип	Описание
Идентификатор модуля	id	string	Идентификатор модуля
project_id	project_id	string
Имя модуля	name	string	Имя модуля
Порядок отображения модуля	order	double	Порядок отображения модуля
Значок модуля	icon	string	Значок модуля
Цвет модуля	color	string	Цвет модуля
Тип модуля	type	string	Тип модуля
names	names	array of LocalizedLabel
Дата создания модуля	created_at	string	Дата создания модуля
Дата обновления модуля	updated_at	string	Дата обновления модуля
Модуль включен	enabled	boolean	Модуль включен
settings	settings	ModuleSettings

ModuleCategory

Имя	Путь	Тип	Описание
Идентификатор категории	id	string	Идентификатор категории
Идентификатор модуля категории	module_id	string	Идентификатор модуля категории
Идентификатор контейнера категории	container_id	string	Идентификатор контейнера категории
Название категории	name	string	Название категории
Идентификатор родительской категории	parent_id	string	Идентификатор родительской категории
Дата создания категории	created_at	string	Дата создания категории
Дата обновления категории	updated_at	string	Дата обновления категории
Дата удаления категории	deleted_at	string	Дата удаления категории
Категория включена	enabled	boolean	Категория включена

ModuleForm

Имя	Путь	Тип	Описание
Идентификатор модуля	id	string	Идентификатор модуля
Код проекта	project_id	string	Код проекта
Имя модуля	name	string	Имя модуля
Порядок модулей	order	double	Порядок отображения модуля
Значок модуля	icon	string	Значок модуля
Цвет модуля	color	string	Цвет модуля
Тип модуля	type	string	Тип модуля
names	names	array of LocalizedLabel
Дата создания модуля	created_at	string	Параметры модуля
Дата обновления модуля	updated_at	string	Параметры модуля
Модуль включен	enabled	boolean	Параметры модуля

ModuleOrgaSuggestion

Имя	Путь	Тип	Описание
Предложение по умолчанию	is_default	boolean	Предложение по умолчанию
Имена предложений	names	array of LocalizedLabel	Имена предложений
id	id	string
container_id	container_id	string
container_type	container_type	string
Имя предложения	name	string	Имя предложения
icon	icon	string
color	color	string
Тип предложения	type	string	Тип предложения
Видимость предложений	visibility	string	Видимость предложений
создано_в	created_at	string
updated_at	updated_at	string

ModuleSettings

Имя	Путь	Тип
is_observation_library_mandatory	is_observation_library_mandatory	boolean
is_description_mandatory	is_description_mandatory	boolean
is_photo_mandatory	is_photo_mandatory	boolean
is_company_mandatory	is_company_mandatory	boolean
is_group_mandatory	is_group_mandatory	boolean
due_date_days_offset	due_date_days_offset	string

ObservationCommonObservation

Имя	Путь	Тип	Описание
Идентификатор CommonObs	id	string	Идентификатор CommonObs
CommonObs Trade Id	trade_id	string	CommonObs Trade Id
Имя CommonObs	name	string	Имя CommonObs
Имена CommonObs	names	array of LocalizedLabel	Имена CommonObs
CommonObs включен	enabled	boolean	CommonObs включен
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

ObservationMediaResource

Имя	Путь	Тип	Описание
Идентификатор носителя	id	string	Идентификатор носителя
Порядок мультимедиа	position	string	Порядок мультимедиа
Тип MIME мультимедиа	mime_type	string	Тип MIME мультимедиа
Имя файла мультимедиа	file_name	string	Имя файла мультимедиа

OrgaMemberResponses

Имя	Путь	Тип
идентификатор пользователя	user_id	string
электронная почта	email	string
первое имя	first_name	string
Фамилия	last_name	string
is_admin	is_admin	boolean
is_pending	is_pending	boolean
media_resource	media_resource	Media

Phase

Имя	Путь	Тип	Описание
Идентификатор этапа	id	string	Идентификатор этапа
Порядок этапов	order	double	Порядок этапов
Название фазы	name	string	Название фазы
Имена этапов	names	array of LocalizedLabel	Имена этапов
Этап включен	enabled	boolean	Этап включен
Дата создания этапа	created_at	string	Дата создания этапа
Дата обновления этапа	updated_at	string	Дата обновления этапа
Дата удаления этапа	deleted_at	string	Дата удаления этапа

Priority

Имя	Путь	Тип	Описание
Идентификатор приоритета	id	string	Идентификатор приоритета
Имя приоритета	name	string	Имя приоритета
Порядок приоритета	position	integer	Порядок приоритета
Цвет приоритета	color	string	Цвет приоритета
icon	icon	IconTypeParameters
Идентификатор приоритета	is_default	boolean	Идентификатор приоритета
Приоритет по умолчанию	names	array of LocalizedLabel	Приоритет по умолчанию
Приоритет включен	enabled	boolean	Приоритет включен
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

Проект

Имя	Путь	Тип	Описание
Код проекта	project_id	string	Код проекта
Идентификатор организации проекта	organization_id	string	Идентификатор организации проекта
Имя проекта	name	string	Имя проекта
Пример проекта	case_number	string	Пример проекта
Идентификатор рабочей области проекта	workspace_id	string	Идентификатор рабочей области проекта
Описание проекта	description	string	Описание проекта
Дата окончания проекта	end_date	string	Дата окончания проекта
Число участников проекта	member_count	integer	Число участников проекта
Проект архивирован	is_archived	boolean	Проект архивирован
media_resource	media_resource	Media
Текущий пользователь в проекте	current_user_in_project	boolean	Текущий пользователь в проекте?
Проект активен	is_active	boolean	Проект активен
Статус проекта	status	string	Статус проекта
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

ProjectRole

Имя	Путь	Тип	Описание
Список пользователей	user_ids	array of string	Список пользователей
Идентификатор роли	id	string	Идентификатор роли
Имя роли	name	string	Имя роли
Имена ролей	names	array of LocalizedLabel	Имена ролей
Описания ролей	descriptions	array of LocalizedLabel	Описания ролей
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

ProjectTrade

Имя	Путь	Тип	Описание
Идентификатор торговли	id	string	Идентификатор торгов
Включен	enabled	boolean	Включен
Название торговли	name	string	Название торговли
Торговые имена	names	array of LocalizedLabel	Торговые имена
Идентификатор модуля	module_id	string	Идентификатор модуля
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

StatusResponseWithoutFlow

Имя	Путь	Тип	Описание
Идентификатор состояния	id	string	Идентификатор состояния
Имя состояния	name	string	Имя состояния
Порядок состояния	position	integer	Порядок состояния
Цвет состояния	color	string	Цвет состояния
Состояние по умолчанию	is_default	boolean	Состояние по умолчанию
Состояние включено	enabled	boolean	Состояние включено
Имена состояний	names	array of LocalizedLabel	Имена состояний
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по

StatusResponseWithoutLanguage

Имя	Путь	Тип	Описание
Идентификатор состояния	id	string	Идентификатор состояния
Имя состояния	name	string	Имя состояния
Порядок состояния	position	integer	Порядок состояния
Цвет состояния	color	string	Цвет состояния
Состояние включено	enabled	boolean	Состояние включено

TimeZones

Имя	Путь	Тип	Описание
Идентификатор часового пояса	id	string	Идентификатор часового пояса
Имя часового пояса	display_name	string	Имя часового пояса
Стандартное имя часового пояса	standard_name	string	Стандартное имя часового пояса
Смещение часового пояса UTC	utc_offset	string	Смещение часового пояса UTC

UploadChunkInit

Имя	Путь	Тип	Описание
Задержка истечения срока действия отправки	expires_after_secs	double	Задержка истечения срока действия отправки
Идентификатор блока	chunk_id	string	Идентификатор блока
Идентификатор носителя	media_id	string	Идентификатор носителя
Минимальный размер блока	min_chunk_size	integer	Минимальный размер блока

Workspace

Имя	Путь	Тип	Описание
Идентификатор рабочей области	workspace_id	string	Идентификатор рабочей области
Имя рабочей области	name	string	Имя рабочей области
Родительский идентификатор рабочей области	parent_id	string	Родительский идентификатор рабочей области
Справочник по рабочей области	client_reference	string	Справочник по рабочей области
media_resource	media_resource	Media
Дата удаления рабочей области	deleted_by	string	Дата удаления рабочей области
Удаленная рабочая область	deleted_at	string	Удаленная рабочая область
Дата создания	created_at	string	Дата создания
Кем создано:	created_by	string	Кем создано:
Дата обновления	updated_at	string	Дата обновления
Автор обновления	updated_by	string	Обновление по