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

Этот соединитель обеспечивает безопасный и прошедший проверку подлинности доступ к API HighQ, что позволяет легко интегрировать возможности совместной работы и управления содержимым в пользовательские рабочие процессы и приложения. Она поддерживает автоматизацию документов, синхронизацию данных и оркестрацию рабочих процессов, что позволяет командам юридических и профессиональных служб оптимизировать операции, сократить усилия вручную и повысить производительность.

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

Услуга	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)

Контакт
Имя	Highq
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Адрес электронной почты	highq-support@thomsonreuters.com

Метаданные соединителя
Publisher	Томсон Рейтер Включен
Веб-сайт	https://legal.thomsonreuters.com/en/products/highq
Политика конфиденциальности	https://www.thomsonreuters.com/en/privacy-statement
Категории	Сотрудничество; Содержимое и файлы

HighQ

Обзор

HighQ обеспечивает простой, безопасный, прошедший проверку подлинности доступ к API HighQ. Этот соединитель обеспечивает простое взаимодействие с различными службами HighQ, включая модули ISheet, API ресурсов документов, API администрирования ISheet и операции пользователей. Она предназначена для упрощения интеграции с платформой HighQ Collaborate, предлагая такие функции, как извлечение и создание элементов iSheet, управление файлами документов и администрирование учетных записей пользователей.

Версия соединителя: 1.0.0
Титул: HighQ
Описание: Этот соединитель обеспечивает простой, безопасный и прошедший проверку подлинности доступ к API HighQ.
Контакт:
- Имя: Highq
- Поддержка веб-сайта:HighQ
- Отправить по электронной почте:highq-support@thomsonreuters.com

Authentication

Соединитель использует динамические переменные среды для безопасного подключения:

Узел: @environmentVariables("highqt_host")
Базовый путь: /@environmentVariables("highqt_instancename")/api
Идентификатор клиента:@environmentVariables("highqt_clientid")
Секрет клиента:@environmentVariables("highqt_clientsecret")

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

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

Модуль ISheet

Получение элементов iSheet
GET /{version}/isheet/{isheetid}/items
Извлекает список элементов в указанном iSheet.
Создание элементов iSheet
POST /{version}/isheet/{isheetid}/items
Вставляет новые элементы в iSheet с поддержкой нескольких таблиц iSheet и отслеживания состояния с помощью прогрессивных ключей.

API ресурсов документа

Получение сведений о файле
GET /{version}/files/{fileid}
Извлекает подробные сведения о конкретном файле на платформе HighQ Для совместной работы.
Отправка файла
POST /{version}/files/content
Отправляет файл в указанную папку, поддерживая блокированные отправки при Content-Range указании заголовка.
Получение списка папок
GET /{version}/folders/{folderid}/items
Извлекает список папок в указанной папке с поддержкой сортировки и разбиения на страницы.

API администрирования ISheet

Получение столбцов iSheet
GET /{version}/isheets/admin/{isheetid}/columns
Извлекает конфигурации столбцов для заданного iSheet.

Операции пользователя

Получение пользователей
GET /{version}/users
Извлекает список пользователей с поддержкой фильтрации, разбивки на страницы и подробных ролей пользователей.
Добавление нового пользователя
POST /{version}/users
Создает новую учетную запись пользователя с расширенными атрибутами и проверкой.
Архивация пользователя
DELETE /{version}/users/{userid}
Архивирует существующего пользователя из системы.

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

Создание папки
POST /{version}/folders
Создает новую папку под указанной родительской папкой.
Перемещение документов
PUT /{version}/files/move
Перемещает один или несколько файлов из одной папки в другую на одном сайте.
Операции управления сайтами:
- Добавьте существующую группу на сайт: POST /{version}/sites/{siteid}/groups/{groupid}
- Обновление группы сайтов: PUT /{version}/sites/{siteid}/groups/{groupid}
- Добавление нового сайта: POST /{version}/sites

Начало работы

Конфигурация:
- Определите переменные highqt_host среды и highqt_instancename в среде Power Platform.
Проверка подлинности:
- Следуйте рекомендациям, предоставленным HighQ, чтобы настроить безопасную проверку подлинности для запросов API.
Использование:
- Импортируйте HighQ в экземпляр Power Platform.
- При необходимости используйте доступные операции. Ознакомьтесь с сводами операций, приведенными выше, для получения рекомендаций.

Параметры и параметры

Параметры пути:
Включите необходимые параметры, такие как version, isheetid, fileidfolderidи userid как применимо.
Параметры запроса:
Необязательные параметры, такие как sheetviewid, sortcolumnidlimitи offset доступны для уточнения ответов API.
Параметры тела:
Для операций, требующих текста запроса (например, создание элементов iSheet или пользователей), убедитесь, что запрос соответствует определенным схемам (напримерisheetDBO, или FolderDBOIntegrationUserDBO).

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

Коды ошибок:
Стандартные коды состояния HTTP используются в операциях:
- 200 для успешных операций
- 401 для несанкционированного доступа
- 403 для запрещенных или проверок сбоев
- 405 для недопустимых методов HTTP
- 500 для ошибок внутреннего сервера
  Дополнительные сведения об ошибках см. в отдельной документации по API.
Ограничения:
Некоторые конечные точки могут иметь ограничения по умолчанию (например, по умолчанию limit — 100 записей). Для сортировки и фильтрации больших наборов данных могут потребоваться дополнительные параметры.

Дополнительные ресурсы

Дополнительные сведения и расширенную документацию см. в следующем:

Техническая поддержка HighQ
Внутренняя документация, сопровождающая пакет соединителя HighQ.

Лицензирование и поддержка

Сведения о лицензировании и технической поддержке:

Контакт: Highq
URL-адрес поддержки: техническая поддержка HighQ
Электронная почта поддержки: highq-support@thomsonreuters.com

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

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

Действия

Архивный пользователь

Этот вызов API используется для архивации пользователя в системе.

Коды ошибок

Сводка	Код ссылки (до версии 4)	Код ссылок (версия 4)
Следующие пользователи не существуют в системе	110	110
Требуется идентификатор пользователя	109	109
Идентификатор пользователя не имеет правильного формата	113	113
Длина идентификатора пользователя не может превышать 50 символов	N/A	304

Билет JIRA: https://dev.highq.com/jira/browse/COL-67441

Добавить пользователя

Этот вызов API используется для добавления нового пользователя в систему.
Примечание.
1. Добавлена поддержка следующих новых полей
emaildomain, org, invitationsent, createdby, createddate, modifiedby, modifieddate, ifpartner, lastlogindate, invalidlogins, externalid, publicwebsiteprofileid, systemuser, resetpassworddate, usertypeid, avatar, practicegroup, langcode, publicprofile, dateOfBirthth
2. Тег адреса добавлен в API версии 4

Сводка	Код ссылки (до версии 4)	Код ссылок (версия 4)
Требуется адрес электронной почты	101	101
Недопустимый адрес электронной почты	104	104
Требуется имя	102	102
Максимально допустимые символы для первого имени должны составлять от 1 до 100	102	352
Адрес электронной почты секретаря или помощника недействителен	104	353
Состояние должно быть активным или неактивным	116	116
Введенный отдел не может быть более 256 символов	N/A	354
Введенный атрибут ifpartner недопустим	N/A	355
Введенный атрибут systemuser недопустим	N/A	356
Введенный атрибут usertypeid недопустим	N/A	357
Введенный атрибут langcode недопустим	N/A	358
Введенный атрибут sourcetype недопустим. Допустимые значения: System, Active Directory или System по умолчанию.	N/A	359
Введите допустимый номер телефона	N/A	360
Введите допустимый номер телефона в формате {countrycode} ${areacode}${number}.	N/A	361
Введите допустимый номер мобильного телефона в формате {countrycode}${number}.	N/A	362
Введите допустимый код страны телефона для офиса	N/A	363
Код страны office phone может содержать не более 4 цифр.	N/A	364
Введите допустимый код области телефона для офиса	N/A	365
Код области office phone может содержать не более 5 цифр	N/A	366
Номер телефона Office должен содержать не более 15 цифр	N/A	368
Введите допустимый код страны мобильного телефона	N/A	369
Код страны мобильного телефона может содержать не более 4 цифр	N/A	372
Введите допустимый номер мобильного устройства	N/A	373
Номер мобильного телефона должен содержать не более 20 цифр	N/A	374
Домен не существует	105	105
Электронная почта уже существует в системе	111	111
Упоминание организации в случае саморегистрированного домена	187	187
Упоминание организации в случае исключительного домена	115	115
Идентификатор организации не имеет правильного формата	112	112
Организация не существует	106	106
Домен существует в другой организации	114	114
Недопустимый идентификатор введенного адреса	N/A	308
Имя социальной ссылки не найдено в системе.	N/A	375
Имя социальной ссылки является обязательным	N/A	376
Значение социальной связи является обязательным	N/A	377
Максимальные символы для значения социальной связи должны составлять от 1 до 500	N/A	378
Введите имя настраиваемой ссылки	N/A	379
Необходимое значение настраиваемой ссылки	N/A	380
Максимальное число символов для имени пользовательской ссылки должно составлять от 1 до 500	N/A	381
Максимальное число символов для значения пользовательской ссылки должно составлять от 1 до 500	N/A	382
Необходимое имя ссылки на сообщение	N/A	383
Имя ссылки сообщения не найдено в системе	N/A	384
Необходимое значение ссылки сообщения	N/A	385
Максимальное число символов для значения ссылки сообщения должно составлять от 1 до 500	N/A	386
Связь с социальными сетями отключена	N/A	408
Ссылка на сообщение отключена	N/A	409
Пользовательская ссылка отключена	N/A	410

Билет JIRA: https://dev.highq.com/jira/browse/COL-65685

Добавление сайта

Используйте этот API для создания нового сайта. Объект сайта поддерживает только атрибуты, видимые в интерфейсе создания сайта.

Для этого API требуется имя сайта (и обязательные поля, настроенные на уровне ASP, если таковые есть) для создания нового сайта.

Тег "module" представляет другой модуль для настройки на сайте, как показано в атрибутах запроса.
Создание сайта из шаблона путем передачи тега sitetemplateid
— Для меньшей версии 7, если в запросе не передается тег модуля (тег модуля не передается), конфигурация модуля шаблона будет выполнена. Если тег модуля предоставляется с конфигурацией, он будет учитывать это и настраивать как указано в запросе (а не использовать конфигурацию модуля шаблона).
— Для большей версии 7, если какой-либо модуль передается (тег модуля передается) или нет в запросе, конфигурация модуля шаблона будет выполнена.

Этот метод не поддерживает отправку образа сайта в этом вызове, поддержка значков сайта будет предоставлена в виде отдельного вызова.
Вызов метода ожидает существующего идентификатора категории. Идентификатор категории должен быть получен вызывающим приложением с помощью более раннего вызова интерфейса категорий сайта. Если в запросе нет категорий, по умолчанию не будет добавлена ни одна категория (не фактическая категория).

Дата начала и окончания сайта должна быть в формате dd MMM гггг, а не в формате UTC. Клиент API всегда запрашивает фактическую дату.

"landingpage" имеет значение по умолчанию в качестве файлов (корневая папка)".
"целевая страница" ожидает три разных формулировки или идентификации для модуля файлов. Возможные значения:
— файлы (корневая папка)
— файлы (последнее действие)
— файлы (расширенный поиск)
Реализация метода теперь поддерживает (начиная с версии 5.1) многоязычный имя сайта. API версии 6 или более поздней <версии sitename> будет представляться в тексте запроса на основе порядка предпочтений пользователя. API версии 5 или более старое <имя> сайта будет представлять английский язык великобритании по умолчанию.
<sitenametranslations> будет представлять имена сайтов на всех языках (что будет дополнительным тегом в API объекта с 5.1 и выше) API версии 6 или выше, в тексте запроса они отправляют оба тега, например <имя сайта и >имя<_сайта>, а затем нам нужно проверить значения, например <имя> сайта, должно соответствовать соответствующему <тегу перевода> с точки зрения языковых предпочтений пользователя. API 7 или более поздней версии, сайт, созданный из шаблона, будет следовать модулям из исходного шаблона, и он будет игнорировать список модулей, отправленный в тексте запроса.

Реализация метода теперь поддерживает создание сайта из шаблона, предоставив тег sitetemplateid (старый подход)

Обратите внимание, что поддержка создания сайта из шаблона с помощью этого API будет нерекомендуема в будущем. Чтобы создать сайт из шаблона, используйте новый api Create site from template (/sites/templates/{templateid}/site), который является длительным API опроса (с поддержкой длительных запросов)

Этот метод поддерживает несколько чисел материи для добавления на сайт с помощью API версии 10. Тег "matternos" указывает на несколько чисел материи с чтением или нет. Более старая версия (менее версии 10) номер одного материи "matterno" будет отражать первое число материи существующих нескольких чисел на сайте.

Версия 18 далее: требуется категория (назначение сайта). Если цель сайта скрыта, отображается сообщение; в противном случае скрытые цели сайта не добавляются на сайт.

До версии 17: владелец сайта является пользователем, вошедшего в систему; другие пользователи не могут быть добавлены.

Версия 18: владелец сайта может добавить других пользователей на сайт.

Начиная с API версии 19, новый модуль представлен как customPages, который тесно связан с домашним модулем. Таким образом, если значение домашнего модуля равно True, customPages будет true и наоборот.

Добавление существующей группы на сайт

Этот метод API добавляет существующую системную группу на сайт.
Этот API был расширен, чтобы добавить существующие системные базовые группы пользователей (типа системы или организации) на сайте.

Обновление группы сайтов

Этот метод API обновляет имя существующей группы на сайте.
Этот API был расширен для обновления имени существующей базовой группы пользователей на сайте.

Обновление сайта

Используйте эту конечную точку API для обновления сведений о существующем сайте. API поддерживает те же поля, которые используются в API создания сайта.

Этот метод поддерживает несколько чисел материи для добавления на сайт с помощью API версии 10. Тег "matternos" указывает на несколько чисел материи с чтением или нет.

Версия 18 далее: требуется категория (назначение сайта). Если цель сайта скрыта, отображается сообщение; в противном случае скрытые цели сайта не добавляются на сайт.

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

Версия 18: владелец сайта может добавить других пользователей на сайт.

Начиная с API версии 19, появился новый модуль с именем customPages, который тесно связан с домашним модулем. Если значение домашнего модуля равно True, настраиваемыеPages должны быть истинными и наоборот.

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

Отправка файла

Этот вызов API отправляет файл в указанную папку на платформе HighQ Collaborate. Он поддерживает блокированные отправки при предоставлении заголовка Content-Range.

Перемещение документов

Этот API перемещает несколько файлов из одной папки в другую на одном сайте.

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

Этот метод содержит сведения о папке заданного идентификатора папки.

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

Этот вызов API получает подробные сведения для указанного файла из платформы HighQ Collaborate.

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

Этот вызов API извлекает список папок, содержащихся в указанной папке. Параметр "limit" задает максимальное количество возвращаемых элементов, а параметр "offset" задает начальную позицию для извлечения данных. Значения по умолчанию применяются, если эти параметры опущены, а папки возвращаются в порядке возрастания по дате создания.

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

Получение списка пользователей, который этот API извлекает список пользователей из системы. Ключевые функции ## — получение сведений о пользователе с несколькими параметрами фильтрации. Поддерживает разбиение на страницы и `limitoffset` — новые параметры запроса и поля, представленные в последних версиях — структурированный ответ с ролями пользователей и атрибутами ## Новые параметры запроса (Version-Specific) — представлен в версии 12: — `systemAdminSearch`если задано `1`значение , возвращает только пользователей с ролью системного администратора. - Представлено в версии 18: — `userid`принимает разделенные запятыми значения (CSV). Обновления текста ответа ## — добавлены новые поля: `emaildomain`- ,`orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcodepublicprofiledateOfBirth`# ## Address Format Change (from V11) — `location` тег был переименован для `address` согласованности. — Пример ответа: ## Роли пользователей (представленные в API версии 11+) — пример ответа: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Ограничения и смещения — ограничение поведения: — по умолчанию: `100` если значение не указано. — используется `-1` для возврата всех записей. — Если значение меньше `-1`, по умолчанию используется `100`значение . - Поведение смещения: — значение по умолчанию: `0` если значение не указано. — Если смещение превышает общее число записей, по умолчанию возвращается `0`значение . ## Новые роли появились — V12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Коды ошибок | Сводка | Код ссылки (до версии 4) | Код ссылок (V4) | |---------|----------------------|--------------| | Недопустимые входные данные для состояния пользователя (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Недопустимый идентификатор организации | N/A | 260 | | Недопустимое `neverinvited` значение (true/false) | N/A | 387 | | Недопустимое `neverlogin` значение (true/false) | N/A | 388 | | Недопустимое `groupids` значение | N/A | 214 | | Недопустимое `notingroup` значение (true/false) | N/A | 389 | | Недопустимо `ordertype` (поддерживается: имя, организация, состояние и т. д.) | N/A | 289 | | Недопустимо `orderby` (поддерживается: asc, desc) | N/A | 290 | | Недопустимое `offset` значение | 138 | 138 | | Недопустимое `limit` значение | 137 | 137 | ## Заметки — начиная с версии 13 этот API открыт для всех пользователей (ранее ограниченных системными администраторами). — Начиная с версии 18, поле указывает, `userregistered2FA` зарегистрирован ли пользователь для 2FA. --- Это описание следует форматированию схемы Swagger 2.0 и должно быть помещено в поле описания в схеме пользовательского соединителя.

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

Этот вызов API извлекает список элементов, содержащихся в указанном iSheet.

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

Этот вызов API извлекает столбцы, связанные с указанным iSheet. Эта функция поддерживается в API версии 3 и выше.

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

Этот API создает новую папку на указанном сайте. Он позволяет предоставить сведения о папке и убедиться, что папка создается в данной родительской папке.

Создание элемента iSheet

Этот вызов API используется для вставки элемента iSheet. Можно поддерживать несколько таблиц iSheet.

Чтобы получить состояние элемента iSheet на основе прогрессивного ключа, вызовите API POST /api/3/progressivekeystatus/{progressive_key}

Например, POST /api/{version}/progressivekeystatus/{progressive_key}

Имя	Тип	Description
progressive_key	String	Ключ для проверки состояния действия.

Ответ


              
              <progressivekeyresponse>

               \t<элементов>

                Элемент \t\t<>

                 \t\t\t\t<itemid>1232</itemid>

                 \t\t\t\t<состояние>SUCCESS</status>

                 \t\t\t\t<statuscode>200</statuscode>

                 \t\t\t\t<\ запись сообщения>успешно добавлена</сообщение>

                \t\t</item>

                Элемент \t\t<>

                 \t\t\t\t<itemid>1233</itemid>

                 \t\t\t\t<состояние>SUCCESS</status>

                 \t\t\t\t<statuscode>200</statuscode>

                 \t\t\t\t<\ запись сообщения>успешно добавлена</сообщение>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Архивный пользователь

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

Этот вызов API используется для архивации пользователя в системе.

Коды ошибок

Сводка	Код ссылки (до версии 4)	Код ссылок (версия 4)
Следующие пользователи не существуют в системе	110	110
Требуется идентификатор пользователя	109	109
Идентификатор пользователя не имеет правильного формата	113	113
Длина идентификатора пользователя не может превышать 50 символов	N/A	304

Билет JIRA: https://dev.highq.com/jira/browse/COL-67441

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	версия API
Идентификатор пользователя	userid	True	string	идентификатор пользователя

Добавить пользователя

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

Сводка	Код ссылки (до версии 4)	Код ссылок (версия 4)
Требуется адрес электронной почты	101	101
Недопустимый адрес электронной почты	104	104
Требуется имя	102	102
Максимально допустимые символы для первого имени должны составлять от 1 до 100	102	352
Адрес электронной почты секретаря или помощника недействителен	104	353
Состояние должно быть активным или неактивным	116	116
Введенный отдел не может быть более 256 символов	N/A	354
Введенный атрибут ifpartner недопустим	N/A	355
Введенный атрибут systemuser недопустим	N/A	356
Введенный атрибут usertypeid недопустим	N/A	357
Введенный атрибут langcode недопустим	N/A	358
Введенный атрибут sourcetype недопустим. Допустимые значения: System, Active Directory или System по умолчанию.	N/A	359
Введите допустимый номер телефона	N/A	360
Введите допустимый номер телефона в формате {countrycode} ${areacode}${number}.	N/A	361
Введите допустимый номер мобильного телефона в формате {countrycode}${number}.	N/A	362
Введите допустимый код страны телефона для офиса	N/A	363
Код страны office phone может содержать не более 4 цифр.	N/A	364
Введите допустимый код области телефона для офиса	N/A	365
Код области office phone может содержать не более 5 цифр	N/A	366
Номер телефона Office должен содержать не более 15 цифр	N/A	368
Введите допустимый код страны мобильного телефона	N/A	369
Код страны мобильного телефона может содержать не более 4 цифр	N/A	372
Введите допустимый номер мобильного устройства	N/A	373
Номер мобильного телефона должен содержать не более 20 цифр	N/A	374
Домен не существует	105	105
Электронная почта уже существует в системе	111	111
Упоминание организации в случае саморегистрированного домена	187	187
Упоминание организации в случае исключительного домена	115	115
Идентификатор организации не имеет правильного формата	112	112
Организация не существует	106	106
Домен существует в другой организации	114	114
Недопустимый идентификатор введенного адреса	N/A	308
Имя социальной ссылки не найдено в системе.	N/A	375
Имя социальной ссылки является обязательным	N/A	376
Значение социальной связи является обязательным	N/A	377
Максимальные символы для значения социальной связи должны составлять от 1 до 500	N/A	378
Введите имя настраиваемой ссылки	N/A	379
Необходимое значение настраиваемой ссылки	N/A	380
Максимальное число символов для имени пользовательской ссылки должно составлять от 1 до 500	N/A	381
Максимальное число символов для значения пользовательской ссылки должно составлять от 1 до 500	N/A	382
Необходимое имя ссылки на сообщение	N/A	383
Имя ссылки сообщения не найдено в системе	N/A	384
Необходимое значение ссылки сообщения	N/A	385
Максимальное число символов для значения ссылки сообщения должно составлять от 1 до 500	N/A	386
Связь с социальными сетями отключена	N/A	408
Ссылка на сообщение отключена	N/A	409
Пользовательская ссылка отключена	N/A	410

Билет JIRA: https://dev.highq.com/jira/browse/COL-65685

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	версия API
index	index		integer	Уникальный индекс для пользователя.
userid	userid		integer	Уникальный идентификатор пользователя.
имя	firstname		string	Имя пользователя.
фамилия	lastname		string	Фамилия пользователя.
практическая группа	practicegroup		string	Группа практики, к которой принадлежит пользователь.
langcode	langcode		string	Языковой код пользователя.
localeID	localeID		string	Идентификатор языкового стандарта пользователя.
publicprofile	publicprofile		string	Общедоступный профиль пользователя.
pwpid	pwpid		string	Идентификатор PWP пользователя.
usertypeid	usertypeid		string	Идентификатор типа пользователя.
systemuser	systemuser		string	Флаг системного пользователя.
электронная почта	email		string	Email адрес пользователя.
phone	phone		string	Номер телефона пользователя.
mobile	mobile		string	Мобильный номер пользователя.
отдел	department		string	Отдел пользователя.
организация	org		string	Организация, к которой принадлежит пользователь.
адресная линия1	addressline1		string	Первая строка адреса.
адресная линия2	addressline2		string	Вторая строка адреса.
адресная линия3	addressline3		string	Третья строка адреса.
city	city		string	Город адреса.
государство	state		string	Состояние адреса.
country	country		string	Страна адреса.
почтовый индекс	postcode		string	Почтовый индекс адреса.
addressid	addressid		string	Уникальный идентификатор адреса.
адресная линия1	addressline1		string	Первая строка адреса.
адресная линия2	addressline2		string	Вторая строка адреса.
адресная линия3	addressline3		string	Третья строка адреса.
city	city		string	Город адреса.
государство	state		string	Состояние адреса.
country	country		string	Страна адреса.
почтовый индекс	postCode		string	Почтовый индекс адреса.
известные	knownas		string	Альтернативное имя или псевдоним для адреса.
опыт	experience		array of string
id	id		string	Идентификатор ссылки
имя	name		string	Имя ссылки.
value	value		string	Значение ссылки.
id	id		string	Идентификатор ссылки
имя	name		string	Имя ссылки.
value	value		string	Значение ссылки.
id	id		string	Идентификатор ссылки
имя	name		string	Имя ссылки.
value	value		string	Значение ссылки.
img	img		string
reportsto	reportsto		string
имя метаданных	metadataname		array of string
metadatavalue	metadatavalue		array of string
group	group		array of string
externalid	externalid		string	Внешний идентификатор пользователя.
jobtitle	jobtitle		string	Название задания пользователя.
имя секретаря	secretaryname		string	Имя секретаря пользователя.
секретарь	secretarymail		string	Электронная почта секретаря пользователя.
Кухни	specialities		string	Специальные особенности пользователя.
title	title		string	Заголовок пользователя.
погоня	goesby		string	предпочтительное имя пользователя.
суффикс	suffix		string	Суффикс имени пользователя.
atomlink	atomlink		string	Ссылка Atom, связанная с пользователем.
био	bio		string	Биография пользователя.
dateOfBirth	dateOfBirth		string	Дата рождения пользователя.
link	link		string	Ссылка, связанная с пользователем.
статус	status		string	Состояние пользователя.
Код состояния	statuscode		string	Код состояния пользователя.
сообщение	message		string	Сообщение, связанное с пользователем.
sourcetype	sourcetype		string	Тип источника пользователя.
orgid	orgid		string	Идентификатор организации.
ifpartner	ifpartner		string	Флаг партнера.
домен электронной почты	emaildomain		string	Домен электронной почты пользователя.
приглашение	invitationsent		string	Отправленный флаг приглашения.
Создание сайта	createdby		string	Пользователь, создавший запись.
createddate	createddate		string	Дата создания записи.
изменено	modifiedby		string	Пользователь, изменивший запись.
измененный откат	modifieddate		string	Дата изменения записи.
lastlogindate	lastlogindate		string	Дата последнего входа.
Invalidlogins	invalidlogins		string	Количество недопустимых попыток входа.
publicwebsiteprofileid	publicwebsiteprofileid		string	Идентификатор профиля общедоступного веб-сайта.
resetpassworddate	resetpassworddate		string	Дата сброса пароля.
аватар	avatar		string	URL-адрес изображения аватара.
следующая учетная запись	followingcount		integer	Количество отслеживаемых пользователей.
количество подписчиков	followercount		integer	Количество последователей.
следующий	following		boolean	Следующий флаг.
роль	role		string	Роль пользователя.
isbasicuser	isbasicuser		string	Базовый флаг пользователя.
encryptedUserId	encryptedUserId		string	Зашифрованный идентификатор пользователя.
саморегистрированное	selfregistered		integer	Саморегистрированное флаг.
registeredWith2FA	registeredWith2FA		string	Флаг регистрации двухфакторной проверки подлинности.
isInternal	isInternal		integer	Внутренний флаг пользователя.
orgName	orgName		string	Название организации.

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

Тело: IntegrationUserDBO

Добавление сайта

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Запрошенная версия API	version	True	string	версия API
id	id		integer	Идентификатор сайта.
имя сайта	sitename		string	Название сайта.
роль	role		string	Роль сайта.
sitedescription	sitedescription		string	Описание сайта.
enabledmodules	enabledmodules		string	Список модулей, включенных для сайта.
sitefolderID	sitefolderID		string	Идентификатор папки сайта.
sitefolderpermission	sitefolderpermission		string	Уровень разрешений для папки сайта.
включать	enable		string	Включение состояния для HomeDBO.
включать	enable		string	Включите состояние для ActivityDBO.
микроблог	microblog		string	Содержимое микроблога, связанное с ActivityDBO.
Docid	docid		string	Идентификатор документа.
blogTitle	blogTitle		string	Заголовок записи блога.
blogContent	blogContent		string	Содержимое записи блога.
showComment	showComment		integer	показать комментарий.
тегСписок	tagList		array of string	Список тегов, связанных с блогом.
статус	status		integer	состояние записи блога.
siteID	siteID		integer	Идентификатор связанного сайта.
автор	author		string	Автор блога.
categoryList	categoryList		array of string	Категории, назначенные записи блога.
notificationTypeID	notificationTypeID		integer	Идентификатор типа уведомления.
сообщение	message		string	Содержимое сообщения, связанное с блогом.
messageCode	messageCode		integer	Код, связанный с сообщением.
внешний идентификатор	externalID		string	Внешний идентификатор, связанный с блогом.
Дата публикации	publishDate		string	Дата публикации блога.
тип процесса	processtype		string	Тип процесса, связанный с блогом.
включать	enable		string	Включение состояния для BlogDBO.
wikiid	wikiid		integer	Уникальный идентификатор вики-сайта.
currentversionid	currentversionid		integer	Идентификатор текущей версии вики-сайта
parentwikiid	parentwikiid		integer	Идентификатор родительского вики-сайта.
wikititle	wikititle		string	Название вики-сайта.
wikicontent	wikicontent		string	Содержимое вики-сайта.
showcomment	showcomment		integer	Указывает, включены ли примечания.
createddate	createddate		string	Дата создания вики-сайта.
измененный откат	modifieddate		string	Дата последнего изменения вики-сайта.
список тегов	taglist		string	Разделенный запятыми список тегов, связанных с вики-сайтом.
вики-path	wikipath		string	Путь к вики-сайту.
wikidraftid	wikidraftid		integer	Идентификатор черновика версии вики-сайта.
черновик	drafttype		string	Тип черновика, связанного с вики-сайтом.
статус	status		integer	Текущее состояние вики-сайта.
wikiversionid	wikiversionid		integer	Идентификатор версии вики-сайта.
index	index		string	Индекс или идентификатор задачи.
parenttaskid	parenttaskid		integer	Идентификатор родительской задачи.
taskid	taskid		integer	Уникальный идентификатор задачи.
title	title		string	Заголовок задачи.
описание	description		string	Подробное описание задачи.
дуэт	duedate		string	Дата выполнения задачи.
startdate	startdate		string	Дата начала запуска задачи.
mattermaptaskid	mattermaptaskid		string	Идентификатор связывания с задачей карты материи.
type	type		string	Тип или категория задачи.
зависимый	dependenton		string	Задачи, от которые зависит эта задача.
daysfromdependent	daysfromdependent		string	Количество дней от зависимой задачи.
ignoreweekend	ignoreweekend		integer	Указывает, игнорируются ли выходные дни в планировании.
duration	duration		integer	Длительность выполнения задачи.
resource	resource		string	Ресурсы, назначенные задаче.
eventTitle	eventTitle		string	Название события.
eventContent	eventContent		string	Содержимое события.
showComment	showComment		integer	Указывает, включены ли комментарии для события.
тегСписок	tagList		array of string	Список тегов, связанных с событием.
статус	status		integer	Текущее состояние события.
siteID	siteID		integer	Идентификатор сайта.
контакт	contact		string	Контактные данные для события.
categoryList	categoryList		array of string	Категории, в которых отображается событие.
notificationTypeID	notificationTypeID		integer	Тип уведомления, связанный с событием.
сообщение	message		string	Сообщение события.
messageCode	messageCode		integer	Код сообщения события.
внешний идентификатор	externalID		string	Внешний идентификатор.
startDate	startDate		string	Дата начала события.
Дата окончания	endDate		string	Дата окончания события.
startTime	startTime		string	Время начала события.
endTime	endTime		string	Время окончания события.
location	location		string	Расположение события.
автор	author		string	Автор события.
тип процесса	processtype		string	Время процесса события.
включать	enable		string	Включите событие.
id	id		integer	Уникальный идентификатор для iSheet.
title	title		string	Заголовок iSheet.
описание	description		string	Описание листа.
статус	status		string	Состояние листа.
accesstype	accesstype		string	Тип доступа листа.
type	type		string	Тип листа.
viewlink	viewlink		string	Ссылка на просмотр iSheet.
разрешенные конфликты	allowsections		string	Разрешены ли разделы.
allowlookup	allowlookup		string	Включены ли поля подстановки.
displayisheet	displayisheet		string	Параметры отображения для iSheet.
searchasdefaultview	searchasdefaultview		string	Указывает, является ли поиск представлением по умолчанию.
enableversion	enableversion		string	Флаг включения управления версиями.
enablesheetalerter	enablesheetalerter		string	Пометка для включения оповещений листа.
alertercondition	alertercondition		string	Условия активации оповещений.
overrideitemmodifieddate	overrideitemmodifieddate		string	Переопределите измененный флаг даты.
enablebulkinsertupdate	enablebulkinsertupdate		string	Включите массовую вставку и обновление.
fielddescriptions	fielddescriptions		string	Описания полей для iSheet.
включение блокировки	enablerowlocking		string	Включите блокировку на уровне строк.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Усечение многострочного текстового флага.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Ограничение символов для многостроек усечения.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Разрешить повторное использование значений списка выбора.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Разрешить повторное использование значений списка показателей.
allowIsheetComments	allowIsheetComments		string	Разрешить комментарии в iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Ограничение записей, разрешенных для общего доступа.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Включено ограничение общего ресурса для записей.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Включите общий доступ к формам для добавления записей.
учетная запись	recordcount		string	Текущее число записей.
sheettypeid	sheettypeid		integer	Идентификатор типа iSheet
включать	enable		string	Включите функции QA.
userid	userid		integer	ИД пользователя
электронная почта	email		string	адрес электронной почты.
httpavatar	httpavatar		string	URL-адрес HTTP аватара.
аватар	avatar		string	Изображение аватара.
userlink	userlink		string	Ссылка на профиль пользователя.
httplink	httplink		string	HTTP-ссылка на профиль пользователя.
phone	phone		string	Номер телефона.
mobile	mobile		string	Мобильный номер.
отдел	department		string	Отдел пользователя.
включать	enable		string	Включение интеграции Contract Express.
adminnote	adminnote		string	Административные заметки, связанные с сайтом.
startdate	startdate		string	Дата начала операции сайта.
enddate	enddate		string	Дата окончания операции сайта.
createddate	createddate		string	Дата создания сайта.
Archiveddate	archiveddate		string	Дата архивирования сайта.
clientno	clientno		string	Номер клиента, связанный с сайтом.
Matterno	matterno		string	Номер вопроса, связанный с сайтом.
целевая страница	landingpage		string	URL-адрес целевой страницы для сайта.
link	link		string	Ссылка, связанная с сайтом.
статус	status		string	Текущее состояние сайта.
statusid	statusid		integer	Идентификатор состояния сайта.
size	size		string	Размер сайта.
выставление счетов	billingnotes		string	Заметки, связанные с выставлением счетов для сайта.
billingnextinvoicedate	billingnextinvoicedate		string	Дата следующего счета для сайта.
billinglastinvoicedate	billinglastinvoicedate		string	Дата последнего счета для сайта.
filepagecount	filepagecount		string	Общее количество страниц файлов на сайте.
maxpagecount	maxpagecount		string	Максимально допустимое число страниц для файлов на сайте.
sitehttplink	sitehttplink		string	Http-ссылка на сайт.
isSyncable	isSyncable		integer	Указывает, можно ли синхронизировать сайт.
enforceusergroups	enforceusergroups		string	Группы пользователей, примененные для сайта.
csvSiteCategory	csvSiteCategory		string	Категория сайта в формате CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Имя сайта на языке по умолчанию.
видимый	visible		integer	Указывает, отображается ли сайт.
siteLogoName	siteLogoName		string	Имя файла логотипа сайта.
siteLogoFileSize	siteLogoFileSize		integer	Размер файла логотипа сайта.
siteLogoHeight	siteLogoHeight		integer	Высота логотипа сайта.
siteLogoWidth	siteLogoWidth		integer	Ширина логотипа сайта.
siteStatus	siteStatus		integer	Код состояния сайта.
applySiteTerms	applySiteTerms		integer	Указывает, применяются ли условия сайта.
siteTerm	siteTerm		string	Термины, примененные к сайту.
termType	termType		integer	Тип терминов, применяемых к сайту.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Указывает, требуются ли условия сайта для следующего входа.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Указывает, включены ли термины сайта по умолчанию.
advancedQAPermission	advancedQAPermission		integer	Расширенный уровень разрешений QA для сайта.
isInternal	isInternal		integer	Указывает, является ли сайт внутренним.
psm	psm		integer	Идентификатор Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Отображаемая метка для сайта.
allowSiteAdministration	allowSiteAdministration		integer	Указывает, разрешено ли администрирование сайта.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Чтобы включить защиту паролей на уровне сайта.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Чтобы включить защиту секретного кода на уровне сайта.
секретный кодUsingAuthApp	passcodeUsingAuthApp		integer	Указывает, используется ли проверка подлинности секретного кода приложением проверки подлинности.
sitePassword	sitePassword		string	Пароль, связанный с сайтом.
ipRestrictionEnable	ipRestrictionEnable		integer	Включение ограничений IP-адресов для доступа к сайту.
availableIP	availableIP		string	Разделенный запятыми список IP-адресов, разрешенных для доступа к сайту.
highqDrive	highqDrive		integer	Указывает, включена ли интеграция HighQ Drive.
applySiteHomePage	applySiteHomePage		integer	Чтобы применить настраиваемую домашнюю страницу для сайта.
siteHomePage	siteHomePage		string	URL-адрес пользовательской домашней страницы для сайта.
siteHomePageType	siteHomePageType		integer	Тип домашней страницы.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Чтобы задать следующее имя входа на домашнюю страницу сайта.
applyDisplayContent	applyDisplayContent		integer	Применение параметров содержимого отображения.
displayContent	displayContent		string	Содержимое для отображения на сайте.
rssSecurity	rssSecurity		integer	Уровень безопасности RSS-канала.
encryptedPassword	encryptedPassword		integer	Указывает, зашифрован ли пароль сайта.
availableIPRangeCSV	availableIPRangeCSV		string	Разделенный запятыми список диапазонов IP-адресов, разрешенных для доступа к сайту.
siteModuleID	siteModuleID		integer	Идентификатор модуля сайта.
icalSecurity	icalSecurity		integer	Уровень безопасности веб-канала iCal.
defaultDisplayContent	defaultDisplayContent		string	Содержимое по умолчанию для отображения на сайте.
defaultEmailAlert	defaultEmailAlert		integer	Включение оповещений электронной почты по умолчанию.
excelReportFooter	excelReportFooter		integer	Включает нижний колонтитул в отчеты Excel.
excelReportFooterText	excelReportFooterText		string	Текст, отображаемый в нижнем колонтитуле отчетов Excel.
объявлениеMLJSON	announcementMLJSON		string	Объявления в формате JSON для сайта.
templateType	templateType		integer	Тип шаблона, используемого для сайта.
templateLicence	templateLicence		integer	Тип лицензии для шаблона сайта.
openChannelAppID	openChannelAppID		string	Идентификатор приложения для интеграции с открытым каналом.
itemid	itemid		integer	Идентификатор элемента, связанного с сайтом.
sitemetadatasheetid	sitemetadatasheetid		integer	Идентификатор листа метаданных, связанного с сайтом.
mysite	mysite		boolean	Указывает, является ли это персональным сайтом пользователя.
lastaccesseddate	lastaccesseddate		string	Дата и время последнего доступа к сайту.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Вкладка метаданных по умолчанию для средства просмотра веб-сайтов.
documentMetadataViewId	documentMetadataViewId		integer	метаданные документа для идентификатора представления.
folderMetadataViewId	folderMetadataViewId		integer	метаданные папки для идентификатора представления.
docSort	docSort		integer	Порядок сортировки документов.
folderSort	folderSort		integer	Порядок сортировки папок.
defaultFolderRenderView	defaultFolderRenderView		integer	Определяет режим представления по умолчанию для папок.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Расположение по умолчанию для вложений задач.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Уникальный идентификатор папки, указанной в качестве расположения по умолчанию для вложений задач.
любимый	favourite		string	избранное состояние.
enabledocumentredaction	enabledocumentredaction		boolean	Указывает, включена ли редактирование документов для сайта.
упоминания групп	mentiongroups		integer	Упомянутые группы.
enablefilerelationships	enablefilerelationships		boolean	Указывает, включены ли связи файлов.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Уровень разрешений, необходимый для управления связями файлов.

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

Тело: site

Добавление существующей группы на сайт

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	version
Идентификатор сайта	siteid	True	string	Идентификатор сайта.
Идентификатор системной группы	groupid	True	string	Идентификатор системной группы, добавляемой на сайт.

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

Тело: sitegroup

Обновление группы сайтов

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	version
Идентификатор сайта	siteid	True	string	Идентификатор сайта.
Версия API	groupid	True	string	`The ID of the site group.`
имя	name		string
id	id		integer
copypermissionsfrom	copypermissionsfrom		string
сообщение	message		string
TypeID	typeID		integer
type	type		string
numberofusers	numberofusers		string
создано	created		string
modified	modified		string
systemGroupID	systemGroupID		integer
описание	description		string
basicusergroup	basicusergroup		integer

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

Тело: sitegroup

Обновление сайта

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

Версия 18: владелец сайта может добавить других пользователей на сайт.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Запрошенная версия API	version	True	string	версия API
Уникальный идентификатор сайта	siteid	True	string	Идентификатор сайта
id	id		integer	Идентификатор сайта.
имя сайта	sitename		string	Название сайта.
роль	role		string	Роль сайта.
sitedescription	sitedescription		string	Описание сайта.
enabledmodules	enabledmodules		string	Список модулей, включенных для сайта.
sitefolderID	sitefolderID		string	Идентификатор папки сайта.
sitefolderpermission	sitefolderpermission		string	Уровень разрешений для папки сайта.
включать	enable		string	Включение состояния для HomeDBO.
включать	enable		string	Включите состояние для ActivityDBO.
микроблог	microblog		string	Содержимое микроблога, связанное с ActivityDBO.
Docid	docid		string	Идентификатор документа.
blogTitle	blogTitle		string	Заголовок записи блога.
blogContent	blogContent		string	Содержимое записи блога.
showComment	showComment		integer	показать комментарий.
тегСписок	tagList		array of string	Список тегов, связанных с блогом.
статус	status		integer	состояние записи блога.
siteID	siteID		integer	Идентификатор связанного сайта.
автор	author		string	Автор блога.
categoryList	categoryList		array of string	Категории, назначенные записи блога.
notificationTypeID	notificationTypeID		integer	Идентификатор типа уведомления.
сообщение	message		string	Содержимое сообщения, связанное с блогом.
messageCode	messageCode		integer	Код, связанный с сообщением.
внешний идентификатор	externalID		string	Внешний идентификатор, связанный с блогом.
Дата публикации	publishDate		string	Дата публикации блога.
тип процесса	processtype		string	Тип процесса, связанный с блогом.
включать	enable		string	Включение состояния для BlogDBO.
wikiid	wikiid		integer	Уникальный идентификатор вики-сайта.
currentversionid	currentversionid		integer	Идентификатор текущей версии вики-сайта
parentwikiid	parentwikiid		integer	Идентификатор родительского вики-сайта.
wikititle	wikititle		string	Название вики-сайта.
wikicontent	wikicontent		string	Содержимое вики-сайта.
showcomment	showcomment		integer	Указывает, включены ли примечания.
createddate	createddate		string	Дата создания вики-сайта.
измененный откат	modifieddate		string	Дата последнего изменения вики-сайта.
список тегов	taglist		string	Разделенный запятыми список тегов, связанных с вики-сайтом.
вики-path	wikipath		string	Путь к вики-сайту.
wikidraftid	wikidraftid		integer	Идентификатор черновика версии вики-сайта.
черновик	drafttype		string	Тип черновика, связанного с вики-сайтом.
статус	status		integer	Текущее состояние вики-сайта.
wikiversionid	wikiversionid		integer	Идентификатор версии вики-сайта.
index	index		string	Индекс или идентификатор задачи.
parenttaskid	parenttaskid		integer	Идентификатор родительской задачи.
taskid	taskid		integer	Уникальный идентификатор задачи.
title	title		string	Заголовок задачи.
описание	description		string	Подробное описание задачи.
дуэт	duedate		string	Дата выполнения задачи.
startdate	startdate		string	Дата начала запуска задачи.
mattermaptaskid	mattermaptaskid		string	Идентификатор связывания с задачей карты материи.
type	type		string	Тип или категория задачи.
зависимый	dependenton		string	Задачи, от которые зависит эта задача.
daysfromdependent	daysfromdependent		string	Количество дней от зависимой задачи.
ignoreweekend	ignoreweekend		integer	Указывает, игнорируются ли выходные дни в планировании.
duration	duration		integer	Длительность выполнения задачи.
resource	resource		string	Ресурсы, назначенные задаче.
eventTitle	eventTitle		string	Название события.
eventContent	eventContent		string	Содержимое события.
showComment	showComment		integer	Указывает, включены ли комментарии для события.
тегСписок	tagList		array of string	Список тегов, связанных с событием.
статус	status		integer	Текущее состояние события.
siteID	siteID		integer	Идентификатор сайта.
контакт	contact		string	Контактные данные для события.
categoryList	categoryList		array of string	Категории, в которых отображается событие.
notificationTypeID	notificationTypeID		integer	Тип уведомления, связанный с событием.
сообщение	message		string	Сообщение события.
messageCode	messageCode		integer	Код сообщения события.
внешний идентификатор	externalID		string	Внешний идентификатор.
startDate	startDate		string	Дата начала события.
Дата окончания	endDate		string	Дата окончания события.
startTime	startTime		string	Время начала события.
endTime	endTime		string	Время окончания события.
location	location		string	Расположение события.
автор	author		string	Автор события.
тип процесса	processtype		string	Время процесса события.
включать	enable		string	Включите событие.
id	id		integer	Уникальный идентификатор для iSheet.
title	title		string	Заголовок iSheet.
описание	description		string	Описание листа.
статус	status		string	Состояние листа.
accesstype	accesstype		string	Тип доступа листа.
type	type		string	Тип листа.
viewlink	viewlink		string	Ссылка на просмотр iSheet.
разрешенные конфликты	allowsections		string	Разрешены ли разделы.
allowlookup	allowlookup		string	Включены ли поля подстановки.
displayisheet	displayisheet		string	Параметры отображения для iSheet.
searchasdefaultview	searchasdefaultview		string	Указывает, является ли поиск представлением по умолчанию.
enableversion	enableversion		string	Флаг включения управления версиями.
enablesheetalerter	enablesheetalerter		string	Пометка для включения оповещений листа.
alertercondition	alertercondition		string	Условия активации оповещений.
overrideitemmodifieddate	overrideitemmodifieddate		string	Переопределите измененный флаг даты.
enablebulkinsertupdate	enablebulkinsertupdate		string	Включите массовую вставку и обновление.
fielddescriptions	fielddescriptions		string	Описания полей для iSheet.
включение блокировки	enablerowlocking		string	Включите блокировку на уровне строк.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Усечение многострочного текстового флага.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	Ограничение символов для многостроек усечения.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Разрешить повторное использование значений списка выбора.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Разрешить повторное использование значений списка показателей.
allowIsheetComments	allowIsheetComments		string	Разрешить комментарии в iSheet.
shareRecordsLimit	shareRecordsLimit		integer	Ограничение записей, разрешенных для общего доступа.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Включено ограничение общего ресурса для записей.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Включите общий доступ к формам для добавления записей.
учетная запись	recordcount		string	Текущее число записей.
sheettypeid	sheettypeid		integer	Идентификатор типа iSheet
включать	enable		string	Включите функции QA.
userid	userid		integer	ИД пользователя
электронная почта	email		string	адрес электронной почты.
httpavatar	httpavatar		string	URL-адрес HTTP аватара.
аватар	avatar		string	Изображение аватара.
userlink	userlink		string	Ссылка на профиль пользователя.
httplink	httplink		string	HTTP-ссылка на профиль пользователя.
phone	phone		string	Номер телефона.
mobile	mobile		string	Мобильный номер.
отдел	department		string	Отдел пользователя.
включать	enable		string	Включение интеграции Contract Express.
adminnote	adminnote		string	Административные заметки, связанные с сайтом.
startdate	startdate		string	Дата начала операции сайта.
enddate	enddate		string	Дата окончания операции сайта.
createddate	createddate		string	Дата создания сайта.
Archiveddate	archiveddate		string	Дата архивирования сайта.
clientno	clientno		string	Номер клиента, связанный с сайтом.
Matterno	matterno		string	Номер вопроса, связанный с сайтом.
целевая страница	landingpage		string	URL-адрес целевой страницы для сайта.
link	link		string	Ссылка, связанная с сайтом.
статус	status		string	Текущее состояние сайта.
statusid	statusid		integer	Идентификатор состояния сайта.
size	size		string	Размер сайта.
выставление счетов	billingnotes		string	Заметки, связанные с выставлением счетов для сайта.
billingnextinvoicedate	billingnextinvoicedate		string	Дата следующего счета для сайта.
billinglastinvoicedate	billinglastinvoicedate		string	Дата последнего счета для сайта.
filepagecount	filepagecount		string	Общее количество страниц файлов на сайте.
maxpagecount	maxpagecount		string	Максимально допустимое число страниц для файлов на сайте.
sitehttplink	sitehttplink		string	Http-ссылка на сайт.
isSyncable	isSyncable		integer	Указывает, можно ли синхронизировать сайт.
enforceusergroups	enforceusergroups		string	Группы пользователей, примененные для сайта.
csvSiteCategory	csvSiteCategory		string	Категория сайта в формате CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	Имя сайта на языке по умолчанию.
видимый	visible		integer	Указывает, отображается ли сайт.
siteLogoName	siteLogoName		string	Имя файла логотипа сайта.
siteLogoFileSize	siteLogoFileSize		integer	Размер файла логотипа сайта.
siteLogoHeight	siteLogoHeight		integer	Высота логотипа сайта.
siteLogoWidth	siteLogoWidth		integer	Ширина логотипа сайта.
siteStatus	siteStatus		integer	Код состояния сайта.
applySiteTerms	applySiteTerms		integer	Указывает, применяются ли условия сайта.
siteTerm	siteTerm		string	Термины, примененные к сайту.
termType	termType		integer	Тип терминов, применяемых к сайту.
nextLoginSiteTerms	nextLoginSiteTerms		integer	Указывает, требуются ли условия сайта для следующего входа.
defaultSiteTermsEnable	defaultSiteTermsEnable		integer	Указывает, включены ли термины сайта по умолчанию.
advancedQAPermission	advancedQAPermission		integer	Расширенный уровень разрешений QA для сайта.
isInternal	isInternal		integer	Указывает, является ли сайт внутренним.
psm	psm		integer	Идентификатор Product Service Manager.
siteLabelDisplay	siteLabelDisplay		string	Отображаемая метка для сайта.
allowSiteAdministration	allowSiteAdministration		integer	Указывает, разрешено ли администрирование сайта.
siteLevelPasswordEnable	siteLevelPasswordEnable		integer	Чтобы включить защиту паролей на уровне сайта.
siteLevelPasscodeEnable	siteLevelPasscodeEnable		integer	Чтобы включить защиту секретного кода на уровне сайта.
секретный кодUsingAuthApp	passcodeUsingAuthApp		integer	Указывает, используется ли проверка подлинности секретного кода приложением проверки подлинности.
sitePassword	sitePassword		string	Пароль, связанный с сайтом.
ipRestrictionEnable	ipRestrictionEnable		integer	Включение ограничений IP-адресов для доступа к сайту.
availableIP	availableIP		string	Разделенный запятыми список IP-адресов, разрешенных для доступа к сайту.
highqDrive	highqDrive		integer	Указывает, включена ли интеграция HighQ Drive.
applySiteHomePage	applySiteHomePage		integer	Чтобы применить настраиваемую домашнюю страницу для сайта.
siteHomePage	siteHomePage		string	URL-адрес пользовательской домашней страницы для сайта.
siteHomePageType	siteHomePageType		integer	Тип домашней страницы.
nextLoginSiteHomePage	nextLoginSiteHomePage		integer	Чтобы задать следующее имя входа на домашнюю страницу сайта.
applyDisplayContent	applyDisplayContent		integer	Применение параметров содержимого отображения.
displayContent	displayContent		string	Содержимое для отображения на сайте.
rssSecurity	rssSecurity		integer	Уровень безопасности RSS-канала.
encryptedPassword	encryptedPassword		integer	Указывает, зашифрован ли пароль сайта.
availableIPRangeCSV	availableIPRangeCSV		string	Разделенный запятыми список диапазонов IP-адресов, разрешенных для доступа к сайту.
siteModuleID	siteModuleID		integer	Идентификатор модуля сайта.
icalSecurity	icalSecurity		integer	Уровень безопасности веб-канала iCal.
defaultDisplayContent	defaultDisplayContent		string	Содержимое по умолчанию для отображения на сайте.
defaultEmailAlert	defaultEmailAlert		integer	Включение оповещений электронной почты по умолчанию.
excelReportFooter	excelReportFooter		integer	Включает нижний колонтитул в отчеты Excel.
excelReportFooterText	excelReportFooterText		string	Текст, отображаемый в нижнем колонтитуле отчетов Excel.
объявлениеMLJSON	announcementMLJSON		string	Объявления в формате JSON для сайта.
templateType	templateType		integer	Тип шаблона, используемого для сайта.
templateLicence	templateLicence		integer	Тип лицензии для шаблона сайта.
openChannelAppID	openChannelAppID		string	Идентификатор приложения для интеграции с открытым каналом.
itemid	itemid		integer	Идентификатор элемента, связанного с сайтом.
sitemetadatasheetid	sitemetadatasheetid		integer	Идентификатор листа метаданных, связанного с сайтом.
mysite	mysite		boolean	Указывает, является ли это персональным сайтом пользователя.
lastaccesseddate	lastaccesseddate		string	Дата и время последнего доступа к сайту.
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	Вкладка метаданных по умолчанию для средства просмотра веб-сайтов.
documentMetadataViewId	documentMetadataViewId		integer	метаданные документа для идентификатора представления.
folderMetadataViewId	folderMetadataViewId		integer	метаданные папки для идентификатора представления.
docSort	docSort		integer	Порядок сортировки документов.
folderSort	folderSort		integer	Порядок сортировки папок.
defaultFolderRenderView	defaultFolderRenderView		integer	Определяет режим представления по умолчанию для папок.
isTaskAttachmentDefault	isTaskAttachmentDefault		integer	Расположение по умолчанию для вложений задач.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	Уникальный идентификатор папки, указанной в качестве расположения по умолчанию для вложений задач.
любимый	favourite		string	избранное состояние.
enabledocumentredaction	enabledocumentredaction		boolean	Указывает, включена ли редактирование документов для сайта.
упоминания групп	mentiongroups		integer	Упомянутые группы.
enablefilerelationships	enablefilerelationships		boolean	Указывает, включены ли связи файлов.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel		integer	Уровень разрешений, необходимый для управления связями файлов.

Отправка файла

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию используемого API.
Отправка файла	file	True	file	Указывает файл, который нужно отправить.
Идентификатор родительской папки	parentfolderid	True	string	Указывает уникальный идентификатор родительской папки, в которой будет отправлен файл.
Переопределение повторяющегося флага	overrideduplicate		boolean	Указывает, следует ли переопределять повторяющиеся отправки файлов.
Имя документа	filename	True	string	Указывает имя документа.
Примечание о версии	versionnote		string	Содержит примечание, описывающее версию файла.
Прогрессивный ключ операции	progressiveoperkey		string	Указывает ключ, используемый для прогрессивных операций во время отправки файла.
Имя базы данных DMS	dmsdatabasename		string	Указывает имя базы данных системы управления документами.
Дата редактирования DMS	dmseditdate		string	Указывает дату изменения, записанную в системе управления документами.
Идентификатор родительской папки DMS	dmsparentfolderid		string	Указывает уникальный идентификатор родительской папки в системе управления документами.
Идентификатор документа DMS	dmsdocid		string	Указывает уникальный идентификатор документа в системе управления документами.
Версия документа DMS	dmsversion		string	Указывает версию документа, записанного в системе управления документами.
Сведения о уведомлении	notification		string	Предоставляет сведения о любых уведомлениях, отправляемых при отправке файла.
Идентификатор пакетной службы	batchid		string	Указывает уникальный идентификатор пакетной операции.
Идентификатор корневой папки	rootfolderid		string	Указывает уникальный идентификатор корневой папки.

Перемещение документов

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

Этот API перемещает несколько файлов из одной папки в другую на одном сайте.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию API.
Идентификатор целевой папки	targetfolder	True	string	Уникальный идентификатор целевой папки, в которой будут перемещаться файлы.
fileidCSV	fileidCSV		string	Список идентификаторов файлов, разделенных запятыми.

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

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

Этот метод содержит сведения о папке заданного идентификатора папки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	версия API
Идентификатор папки	folderid	True	string	folderID
Сведения о состоянии	statusinfo		boolean	Параметр statusinfo позволяет получить доступ к дополнительным сведениям о папке. Доступные сведения включают общий статус, избранное состояние для пользователя, вошедшего в систему.

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

Тело: FolderDBOV2

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

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

Этот вызов API получает подробные сведения для указанного файла из платформы HighQ Collaborate.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию используемого API.
Идентификатор файла	fileid	True	string	Указывает уникальный идентификатор файла.
Последний флаг сведений DMS	lastdmsinfo		boolean	Указывает, следует ли получать последние сведения из системы управления документами.
Тип папки	foldertype		string	Указывает тип папки, если это применимо.
Включение сведений о состоянии файла	statusinfo		boolean	Указывает, следует ли включать дополнительные сведения о состоянии файла, такие как общий статус, состояние избранного, количество задач и состояние "Нравится". По умолчанию используется значение false.
Включение метаданных электронной почты	emailmetadata		boolean	Указывает, следует ли включать метаданные электронной почты, такие как отправитель, получатели и метки времени. По умолчанию используется значение false.

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

Тело: DocumentDBO

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию используемого API.
Идентификатор папки	folderid	True	string	Указывает уникальный идентификатор папки.
Ограничение элементов	limit		string	Указывает максимальное количество возвращаемых элементов.
Смещение элементов	offset		string	Задает начальную позицию возвращаемых элементов.
Направление порядка сортировки	orderby		string	Указывает направление заказа для сортировки элементов. Используйте asc для возрастания или desc для убывающего порядка.
Критерий сортировки	ordertype		string	Указывает критерий сортировки элементов, таких как имя, автор или дата последнего изменения.
Включение сведений о состоянии папки	statusinfo		boolean	Указывает, следует ли включать дополнительные сведения о состоянии папки. По умолчанию используется значение false.
Включение смарт-папок	includesmartfolder		boolean	Указывает, следует ли включать смарт-папки в возвращаемый список. По умолчанию используется значение false.

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

Имя	Путь	Тип	Описание
folder	folder	array of object
items	folder	object

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

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

Получение списка пользователей, который этот API извлекает список пользователей из системы. Ключевые функции ## — получение сведений о пользователе с несколькими параметрами фильтрации. Поддерживает разбиение на страницы и `limitoffset` — новые параметры запроса и поля, представленные в последних версиях — структурированный ответ с ролями пользователей и атрибутами ## Новые параметры запроса (Version-Specific) — представлен в версии 12: — `systemAdminSearch`если задано `1`значение , возвращает только пользователей с ролью системного администратора. - Представлено в версии 18: — `userid`принимает разделенные запятыми значения (CSV). Обновления текста ответа ## — добавлены новые поля: `emaildomain`- ,`orginvitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcodepublicprofiledateOfBirth`# ## Address Format Change (from V11) — `location` тег был переименован для `address` согласованности. — Пример ответа: ## Роли пользователей (представленные в API версии 11+) — пример ответа: `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## Ограничения и смещения — ограничение поведения: — по умолчанию: `100` если значение не указано. — используется `-1` для возврата всех записей. — Если значение меньше `-1`, по умолчанию используется `100`значение . - Поведение смещения: — значение по умолчанию: `0` если значение не указано. — Если смещение превышает общее число записей, по умолчанию возвращается `0`значение . ## Новые роли появились — V12: , `Basic UserAllow user to bypass XSS protection` - : `Allow user to manage Contract Express system groups`## Коды ошибок | Сводка | Код ссылки (до версии 4) | Код ссылок (V4) | |---------|----------------------|--------------| | Недопустимые входные данные для состояния пользователя (ACTIVE, ARCHIVED, INACTIVE) | 147 | 147 | | Недопустимый идентификатор организации | N/A | 260 | | Недопустимое `neverinvited` значение (true/false) | N/A | 387 | | Недопустимое `neverlogin` значение (true/false) | N/A | 388 | | Недопустимое `groupids` значение | N/A | 214 | | Недопустимое `notingroup` значение (true/false) | N/A | 389 | | Недопустимо `ordertype` (поддерживается: имя, организация, состояние и т. д.) | N/A | 289 | | Недопустимо `orderby` (поддерживается: asc, desc) | N/A | 290 | | Недопустимое `offset` значение | 138 | 138 | | Недопустимое `limit` значение | 137 | 137 | ## Заметки — начиная с версии 13 этот API открыт для всех пользователей (ранее ограниченных системными администраторами). — Начиная с версии 18, поле указывает, `userregistered2FA` зарегистрирован ли пользователь для 2FA. --- Это описание следует форматированию схемы Swagger 2.0 и должно быть помещено в поле описания в схеме пользовательского соединителя.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Версия API.
Состояние пользователя	status		string	Фильтрация пользователей по состоянию: активный, архивированный, неактивный или заблокированный.
Смещение разбиения на страницы	offset		string	Начальная позиция для разбиения на страницы.
Ограничение результатов	limit		string	Количество элементов, возвращаемых для каждого запроса.
Идентификатор организации	orgid		string	Фильтрация пользователей по идентификатору организации.
Никогда не приглашать пользователей	neverinvited		string	Извлеките пользователей, которые никогда не были приглашены.
Никогда не вошедшего в систему пользователей	neverlogin		string	Получение пользователей, которые никогда не вошли в систему.
Идентификатор пользователя	userid		string	Фильтрация пользователей по уникальным идентификаторам пользователя.
Идентификатор группы	groupid		string	Фильтрация пользователей по идентификаторам группы.
Пользователи не в группах	notingroup		string	Извлеките пользователей, которые не находятся в какой-либо группе.
Тип порядка сортировки	ordertype		string	Сортировка пользователей по указанному полю, например имени, организации или состояния.
Порядок сортировки	orderby		string	Сортировка приводит к возрастанию или убыванию.
Внешний идентификатор	externalid		string	Фильтрация пользователей по внешнему идентификатору.
Имя (Первое имя)	firstname		string	Фильтрация пользователей по имени.
Фамилия	lastname		string	Фильтрация пользователей по фамилии.
Электронная почта	email		string	Фильтрация пользователей по адресу электронной почты.
Поиск пользователей	search		string	Поиск пользователей по различным атрибутам, включая имя, электронную почту и название задания.
Фильтр алфавита	alphabets		string	Фильтруйте пользователей, фамилия которых начинается с определенной буквы.
Должность	jobtitle		string	Фильтрация пользователей по названию задания.
Местоположение	locations		string	Фильтрация пользователей по городу.
Отдел	departments		string	Фильтрация пользователей по отделу.
Название организации	organisations		string	Фильтрация пользователей по имени организации.
Специальностей	specialities		string	Фильтрация пользователей по своим специальностям.
Поиск системного администратора	systemAdminSearch		string	Получение пользователей с помощью роли системного администратора.

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

Тело: users

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

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

Этот вызов API извлекает список элементов, содержащихся в указанном iSheet.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию используемого API.
Идентификатор iSheet	isheetid	True	integer	Указывает уникальный идентификатор iSheet.
Идентификатор представления iSheet	sheetviewid		integer	Указывает идентификатор представления iSheet. Если опущено, возвращается представление по умолчанию.
Идентификатор столбца сортировки	sortcolumnid		integer	Указывает идентификатор столбца, используемого для сортировки результатов.
Порядок сортировки	sortorder		integer	Указывает порядок сортировки. Например, используйте 0 для возрастания или другого значения для убывающего порядка.
Ограничение записи	limit		integer	Указывает максимальное количество возвращаемых записей; Значение по умолчанию равно 100, если не указано.
Смещение записи	offset		integer	Указывает начальную позицию для извлечения записей; Значение по умолчанию равно 0, если не указано.
Включить все столбцы	allColumnRequired		boolean	Флаг, указывающий, следует ли включать все данные столбцов независимо от текущего представления.
Игнорировать ограничения представления	isIgnoreView		boolean	Флаг, указывающий, следует ли игнорировать ограничения просмотра при получении данных элемента.

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

Имя	Путь	Тип	Описание
isheet	isheet	array of object	Список элементов iSheet.
идентификатор_элемента	isheet.itemId	string	Уникальный идентификатор элемента.
данные	isheet.data	array of object	Подробные данные элемента.
последовательность	isheet.data.sequence	string	Порядковый номер, связанный с данными.
columnDisplayName	isheet.data.columnDisplayName	string	Отображаемое имя столбца.
value	isheet.data.value	string	Значение, содержащееся в столбце.

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

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

Этот вызов API извлекает столбцы, связанные с указанным iSheet. Эта функция поддерживается в API версии 3 и выше.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор iSheet	isheetid	True	integer	Указывает уникальный идентификатор iSheet, для которого требуются столбцы.
Версия API	version	True	string	Указывает версию используемого API.
Идентификатор представления iSheet	sheetviewid		string	Указывает идентификатор представления iSheet. Если опущено, возвращаются все столбцы.
Включение удаленных столбцов iSheet	onlyForDeletedIsheet		boolean	Указывает, следует ли включать столбцы из удаленного iSheet. По умолчанию используется значение false.

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

Тело: columns

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Указывает версию API.
Идентификатор пакетной службы	batchid		string	Уникальный идентификатор для пакетной операции.
Идентификатор корневой папки	rootfolderid		string	Уникальный идентификатор корневой папки.
Идентификатор родительской папки	parentfolderid	True	string	Уникальный идентификатор родительской папки, в которой будет создана новая папка.
Разрешить повторяющиеся папки	allowduplicatefolder		boolean	Указывает, разрешены ли повторяющиеся папки в указанной родительской папке.
имя	name	True	string	Имя папки.
описание	description		string	Описание папки.
accessInherited	accessInherited		integer	Указывает, наследуется ли доступ к папке.
batchID	batchID		string	Идентификатор пакета для операции.
dmsfolderid	dmsfolderid		string	Идентификатор папки DMS.
dmsParentFolderID	dmsParentFolderID		string	Идентификатор родительской папки DMS.
dmscreateddate	dmscreateddate		date-time	Дата создания папки DMS.
dmsmodifiedBy	dmsmodifiedBy		string	Пользователь, который последний раз изменил папку DMS.
dmsdatabasename	dmsdatabasename		string	Имя базы данных DMS.
dmslink	dmslink		boolean	Указывает, доступна ли ссылка DMS.
dmslinkby	dmslinkby		string	Пользователь, связанный с папкой DMS.
метаданные электронной почты	emailmetadata		string	Метаданные электронной почты, связанные с папкой.

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

Тело: FolderDBOV1

Создание элемента iSheet

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

Этот вызов API используется для вставки элемента iSheet. Можно поддерживать несколько таблиц iSheet.

Например, POST /api/{version}/progressivekeystatus/{progressive_key}

Имя	Тип	Description
progressive_key	String	Ключ для проверки состояния действия.

Ответ


              
              <progressivekeyresponse>

               \t<элементов>

                Элемент \t\t<>

                 \t\t\t\t<itemid>1232</itemid>

                 \t\t\t\t<состояние>SUCCESS</status>

                 \t\t\t\t<statuscode>200</statuscode>

                 \t\t\t\t<\ запись сообщения>успешно добавлена</сообщение>

                \t\t</item>

                Элемент \t\t<>

                 \t\t\t\t<itemid>1233</itemid>

                 \t\t\t\t<состояние>SUCCESS</status>

                 \t\t\t\t<statuscode>200</statuscode>

                 \t\t\t\t<\ запись сообщения>успешно добавлена</сообщение>

                \t\t</item>

               \t</items>

              </progressivekeyresponse>

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Версия API	version	True	string	Версия API
Идентификатор iSheet	isheetid	True	integer	Идентификатор iSheet
Идентификатор представления листа	sheetviewid		integer	Идентификатор представления iSheet (необязательно)
id	id		integer	Идентификатор isheet.
title	title		string	Заголовок листа.
описание	description		string	Описание листа.
статус	status		string	Состояние листа.
accesstype	accesstype		string	Тип доступа листа.
type	type		string	Тип листа.
viewlink	viewlink		string	ССЫЛКА НА URL-адрес для просмотра листа.
разрешенные конфликты	allowsections		string	Указывает, разрешены ли разделы.
allowlookup	allowlookup		string	Указывает, разрешено ли поиск.
displayisheet	displayisheet		string	Отображение isheet.
searchasdefaultview	searchasdefaultview		string	Задает поиск в качестве представления по умолчанию.
enableversion	enableversion		string	Включите версию.
enablesheetalerter	enablesheetalerter		string	Активирует оповещение листа.
alertercondition	alertercondition		string	Условие активации оповещений.
overrideitemmodifieddate	overrideitemmodifieddate		string	За поездкой дата изменения элемента.
enablebulkinsertupdate	enablebulkinsertupdate		string	Разрешить массовое обновление вставки.
fielddescriptions	fielddescriptions		string	описание полей.
включение блокировки	enablerowlocking		string	Включает блокировку строк.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	Включает усечение ограничения символов для многострочного текста.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	задает ограничение символов для усечения.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse		string	Разрешает повторное использование значений списка выбора.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	Позволяет повторно использовать значения списка показателей.
allowIsheetComments	allowIsheetComments		string	Разрешает комментарии на листе.
shareRecordsLimit	shareRecordsLimit		integer	Ограничение общих записей.
shareRecordsLimitEnabled	shareRecordsLimitEnabled		integer	Включите ограничение записи общего доступа.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	Включает общий доступ к форме добавления записи.
allowViewBaseRendering	allowViewBaseRendering		string	Разрешает базовую отрисовку представлений.
столбец	column		object
учетная запись	recordcount		string	Общее количество записей.
viewId	viewId		integer	Уникальный идентификатор представления.
siteId	siteId		integer	Идентификатор связанного сайта.
название сайта	siteName		string	Имя сайта.
sheetName	sheetName		string	Имя листа.
viewName	viewName		string	Имя представления.
sheetId	sheetId		integer	Идентификатор листа.
последовательность	sequence		string	Порядковый номер столбца заголовка.
columnValue	columnValue		string	Значение столбца заголовка.
columnTypeId	columnTypeId		string	Идентификатор типа столбца.
columnId	columnId		string	Уникальный идентификатор столбца.
columnTypeAlias	columnTypeAlias		string	Имя псевдонима для типа столбца.
itemsequence	itemsequence		string	Порядковый номер элемента.
itemid	itemid		string	Уникальный идентификатор элемента.
externalid	externalid		string	Внешний идентификатор, связанный с элементом.
columnid	columnid		integer	Уникальный идентификатор столбца
имя	name		string	Имя столбца
type	type		integer	Тип данных столбца.
systemgeneratedtype	systemgeneratedtype		string	Сведения о типах, созданных системой.
section	section		integer	Номер раздела, в котором находится столбец.
описание	description		string	Подробное описание столбца.
addtodefaultview	addtodefaultview		string	Указывает, добавляется ли столбец в представление по умолчанию.
columnconditionstate	columnconditionstate		string	Состояние состояния столбца.
rowid	rowid		integer	Идентификатор строки.
columnid	columnid		integer	Идентификатор столбца.
operatorid	operatorid		integer	Идентификатор оператора.
oprand	oprand		string	Значение операнда для фильтра.
логический тип	logicaltype		string	Логический тип фильтра.
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	Идентификатор типа значения фильтра листа.
displaytype	displaytype		string	Тип отображения фильтра.
sourceColumnId	sourceColumnId		integer	Исходный идентификатор столбца для фильтра.
scoreConditionTypeid	scoreConditionTypeid		integer	Идентификатор типа условия оценки.
значение по умолчанию	defaultvalue		string	Значение по умолчанию для столбца.
columnwidth	columnwidth		string	Ширина столбца.
имя листа	sheetname		string	Имя связанного листа.
имя сайта	sitename		string	Имя сайта.
обязательный	mandatory		string	Указывает, является ли столбец обязательным.
allowsearch	allowsearch		string	Указывает, разрешен ли поиск.
maxchars	maxchars		integer	Максимальное число символов.
allowfieldfromanotherisheet	allowfieldfromanotherisheet		string	Разрешает поле из другого листа.
allowrichhtmltext	allowrichhtmltext		string	Указывает, разрешен ли форматированный HTML-текст.
numberoflines	numberoflines		integer	Количество строк в столбце.
displaymethod	displaymethod		string	Метод, используемый для отображения столбца.
includeotheroption	includeotheroption		string	Включает параметр "Другое".
singleormultileselectioninsearch	singleormultileselectioninsearch		string	Указывает тип выбора в поиске.
id	id		string	Уникальный идентификатор для выбора".
label	label		string	Метка для выбора.
счёт	score		string	Оценка, связанная с выбором.
color	color		string	Цветной код для выбора.
imageid	imageid		integer	Идентификатор связанного изображения.
includeinalertpreferences	includeinalertpreferences		string	Включается в настройки оповещения.
min	min		string	Минимальное значение столбца.
max	max		string	Максимальное значение столбца.
десятичные значения	decimalplaces		integer	Число десятичных разрядов.
showthousandseparators	showthousandseparators		string	Отображает разделители тысяч.
showaspercentage	showaspercentage		string	Отображает значение в процентах.
formattype	formattype		string	Указывает тип формата столбца.
dateformat	dateformat		string	Определяет формат даты для столбца.
defaultdateandtime	defaultdateandtime		string	Задает значение даты и времени по умолчанию для столбца.
sheetlookup	sheetlookup		string	Указывает, является ли столбец подстановкой на другой лист.
fielddisplay	fielddisplay		string	Определяет, как отображается поле.
allowmultipleusers	allowmultipleusers		string	Указывает, может ли несколько пользователей получить доступ к полю.
methodtype	methodtype		string	Определяет тип метода для столбца.
листовые идентификаторы	sheetids		string	Выводит идентификаторы листов, связанных с столбцом.
allowuserstorenamelinks	allowuserstorenamelinks		string	Указывает, могут ли пользователи переименовать ссылки в столбце.
sheetid	sheetid		integer	Указывает идентификатор листа.
columnids	columnids		string	Выводит идентификаторы столбцов.
viewid	viewid		integer	Указывает идентификатор представления.
allowmultiplevalues	allowmultiplevalues		string	Указывает, разрешено ли в столбце несколько значений.
restrictdelete	restrictdelete		string	Указывает, ограничено ли удаление столбца.
displaycolumnnameprefix	displaycolumnnameprefix		string	Задает префикс для отображаемого имени столбца.
имя ссылки	linkname		string	Определяет имя ссылки, связанной с столбцом.
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	Указывает, исключены ли выходные дни в подсчете.
currentsheetcolumnid	currentsheetcolumnid		integer	Идентификатор текущего столбца листа.
targetsheetcolumnid	targetsheetcolumnid		integer	Идентификатор целевого столбца листа.
формула	formula		string	Задает формулу, примененную к столбцу.
startvalue	startvalue		integer	Задает начальное значение столбца.
prefix	prefix		string	Определяет префикс для значений столбцов.
постфикс	postfix		string	Определяет постфикс для значений столбцов.
minlength	minlength		integer	Указывает минимальную длину значений столбцов.
lookupglossarysheetid	lookupglossarysheetid		integer	Указывает идентификатор листа глоссария подстановки.
lookupglossarysheetviewid	lookupglossarysheetviewid		integer	Указывает идентификатор представления листа глоссария подстановки.
Ширина	width		integer	Задает ширину столбца.
другие значенияcorevalue	otherscorevalue		string	Определяет другое значение оценки для столбца.
importdatafromexternalsource	importdatafromexternalsource		string	Указывает, импортируются ли данные из внешнего источника.
analysisengine	analysisengine		string	Задает подсистему анализа, используемую для столбца.
attachmentcustomfolderid	attachmentcustomfolderid		integer	Указывает идентификатор пользовательской папки для вложений.
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	Указывает, находится ли папка вложения на текущем сайте.
singleLineEmailValidation	singleLineEmailValidation		string	Указывает, применяется ли однострочный проверка электронной почты.
Только для чтения	readonly		string	Указывает, доступен ли столбец только для чтения.
virtualColumn	virtualColumn		integer	Указывает, является ли столбец виртуальным.
allowInlineEditing	allowInlineEditing		string	Указывает, разрешено ли встроенное редактирование столбца.
последовательность	sequence		string	Порядковый номер столбца.
attributecolumnid	attributecolumnid		string	Идентификатор столбца атрибутов.
value	value		string	Значение необработанных данных.
date	date		string	дата необработанных данных.
time	time		string	Время необработанных данных.
linkdisplayname	linkdisplayname		string	Отображаемое имя ссылки.
linkdisplayurl	linkdisplayurl		string	Отображаемая ссылка URL-адреса.
id	id		string	Идентификатор подстановки
электронная почта	email		string	Адрес электронной почты.
userlookuptype	userlookuptype		string	Тип подстановки пользователя.
folderid	folderid		string	Идентификатор папки.
Docid	docid		string	Идентификатор документа.
fromdate	fromdate		string	С даты.
todate	todate		string	На сегодняшний день.
file	file		string	Содержимое файла.
имя	name		string	Имя вложения.
заказ	order		string	Порядок вложения.
id	id		integer	Уникальный идентификатор для вложения.
Расширение	extension		string	Расширение файла.
parentfolderid	parentfolderid		integer	Идентификатор родительской папки.
filehttplink	filehttplink		string	HTTP-ссылка для доступа к файлу.
путь к папке	folderpath		string	Путь к папке, содержащей файл.
folderhttplink	folderhttplink		string	HTTP-ссылка на папку.
filesize	filesize		integer	Размер файла в байтах.
redactionStatus	redactionStatus		boolean	Указывает, редактируется ли файл.
displayname	displayname		string	Отображаемое имя вложения.
siteid	siteid		integer	Идентификатор сайта, связанного с вложением.
Идентификатор записи	recordid		string	Идентификатор записи.
имя ссылки	linkname		string	Имя ссылки.
apilink	apilink		string	Ссылка API.
httplink	httplink		string	HTTP-ссылка.
colViewPosition	colViewPosition		integer	Позиция столбца в представлении.
columntype	columntype		string	Тип столбца.
дата создания	createdDate		date-time	Дата и время создания столбца.
modifiedDate	modifiedDate		date-time	Дата и время последнего изменения столбца.
injectReferenceColumn	injectReferenceColumn		integer	Ссылка на внедренный столбец
parentColumnID	parentColumnID		integer	Идентификатор родительского столбца.
reusecolumnidfromisheet	reusecolumnidfromisheet		integer	Идентификатор столбца, повторно используемый на входном листе.
choicelistid	choicelistid		integer	Идентификатор списка выбора, связанного с столбцом.
alerteroption	alerteroption		string	Параметр генерации оповещений для элемента.
sheettypeid	sheettypeid		integer	Идентификатор типа листа.
enableSmartForm	enableSmartForm		string	Активирует функции интеллектуальной формы.
allowDeletedItemsView	allowDeletedItemsView		string	Позволяет просматривать удаленные элементы.
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	Разрешает все столбцы в пользовательских представлениях.

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

Тело: ProgressiveKeyDBO

Определения

ErrorDBO

Имя	Путь	Тип
summary	summary	string
ref	ref	string
link	link	string

DocumentDBO

Имя	Путь	Тип	Описание
Docid	docid	string	Идентификатор документа.

columns

Имя	Путь	Тип	Описание
столбец	column	array of object
items	column	object

LocationDBO

Имя	Путь	Тип	Описание
адресная линия1	addressline1	string	Первая строка адреса.
адресная линия2	addressline2	string	Вторая строка адреса.
адресная линия3	addressline3	string	Третья строка адреса.
city	city	string	Город адреса.
государство	state	string	Состояние адреса.
country	country	string	Страна адреса.
почтовый индекс	postcode	string	Почтовый индекс адреса.

Имя пользователя

Имя	Путь	Тип	Описание
title	title	string	Заголовок пользователя.
имя	firstname	string	Имя пользователя.
фамилия	lastname	string	Фамилия пользователя.
погоня	goesby	string	предпочтительное имя пользователя.

MetadataListDBO

Имя	Путь	Тип	Описание
имя метаданных	metadataname	array of string
metadatavalue	metadatavalue	array of string

NameValueLink

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

Link

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

ExperiencesDBO

Имя	Путь	Тип	Описание
опыт	experience	array of string

GroupsDBO

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

Пользователь

Имя	Путь	Тип	Описание
userid	userid	integer	ИД пользователя
следующий	following	boolean	Следующий.
электронная почта	email	string	Адрес электронной почты.
имя	name	UserName
userlink	userlink	string	Ссылка пользователя.
httplink	httplink	string	HTTP-ссылка.
httpavatar	httpavatar	string	Аватар HTTP.
аватар	avatar	integer	Аватар пользователя.
externalid	externalid	string	Внешний идентификатор.
dateofbirth	dateofbirth	string	Дата рождения.
phone	phone	string	Номер телефона.
jobtitle	jobtitle	string	Название задания.
mobile	mobile	string	Мобильный номер.
отдел	department	string	Депармент.
статус	status	string	Состояние.
организация	org	string	Организация.
orgName	orgName	string	Имя организации.
location	location	LocationDBO
img	img	string	Образ.
Опытом	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
customlink	customlink	Link
обмен сообщениями	messaginglink	Link
имя секретаря	secretaryname	string	Имя секретаря.
секретарь	secretarymail	string	Почта секретаря.
био	bio	string	Биография пользователя.
sourcetype	sourcetype	string	Тип источника.
Кухни	specialities	string	Кухни.
reportsto	reportsto	string	Пользователь сообщает текущему пользователю.
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
суффикс	suffix	string	Суффикс имени пользователя.
atomlink	atomlink	string	Ссылка Atom, связанная с пользователем.
link	link	string	Ссылка, связанная с пользователем.
loggeduserlike	loggeduserlike	integer	Количество нравится от пользователя, вошедшего в систему.
userName	userName	string	Имя пользователя.

users

Имя	Путь	Тип	Описание
Пользователь	user	array of user

FolderDBOV1

Имя	Путь	Тип	Описание
folderid	folderid	string	Уникальный идентификатор созданной папки.

DmsDBO

Имя	Путь	Тип	Описание
dmsfolderid	dmsfolderid	string	Идентификатор папки DMS.
dmsParentFolderID	dmsParentFolderID	string	Идентификатор родительской папки DMS.
dmscreateddate	dmscreateddate	date-time	Дата создания папки DMS.
dmsmodifiedBy	dmsmodifiedBy	string	Пользователь, который последний раз изменил папку DMS.
dmsdatabasename	dmsdatabasename	string	Имя базы данных DMS.
dmslink	dmslink	boolean	Указывает, доступна ли ссылка DMS.
dmslinkby	dmslinkby	string	Пользователь, связанный с папкой DMS.

sitegroup

Имя	Путь	Тип
имя	name	string
id	id	integer
copypermissionsfrom	copypermissionsfrom	string
сообщение	message	string
TypeID	typeID	integer
type	type	string
numberofusers	numberofusers	string
создано	created	string
modified	modified	string
systemGroupID	systemGroupID	integer
описание	description	string
basicusergroup	basicusergroup	integer

Address

Имя	Путь	Тип	Описание
addressid	addressid	string	Уникальный идентификатор адреса.
адресная линия1	addressline1	string	Первая строка адреса.
адресная линия2	addressline2	string	Вторая строка адреса.
адресная линия3	addressline3	string	Третья строка адреса.
city	city	string	Город адреса.
государство	state	string	Состояние адреса.
country	country	string	Страна адреса.
почтовый индекс	postCode	string	Почтовый индекс адреса.
известные	knownas	string	Альтернативное имя или псевдоним для адреса.

IntegrationUserDBO

Имя	Путь	Тип	Описание
index	index	integer	Уникальный индекс для пользователя.
userid	userid	integer	Уникальный идентификатор пользователя.
имя	firstname	string	Имя пользователя.
фамилия	lastname	string	Фамилия пользователя.
практическая группа	practicegroup	string	Группа практики, к которой принадлежит пользователь.
langcode	langcode	string	Языковой код пользователя.
localeID	localeID	string	Идентификатор языкового стандарта пользователя.
publicprofile	publicprofile	string	Общедоступный профиль пользователя.
pwpid	pwpid	string	Идентификатор PWP пользователя.
usertypeid	usertypeid	string	Идентификатор типа пользователя.
systemuser	systemuser	string	Флаг системного пользователя.
электронная почта	email	string	Email адрес пользователя.
phone	phone	string	Номер телефона пользователя.
mobile	mobile	string	Мобильный номер пользователя.
отдел	department	string	Отдел пользователя.
организация	org	string	Организация, к которой принадлежит пользователь.
location	location	LocationDBO
address	address	Address
Опытом	experiences	ExperiencesDBO
sociallinks	sociallinks	Link
обмен сообщениями	messaginglink	Link
customlink	customlink	Link
img	img	string
reportsto	reportsto	string
metadata	metadata	MetadataListDBO
groups	groups	GroupsDBO
externalid	externalid	string	Внешний идентификатор пользователя.
jobtitle	jobtitle	string	Название задания пользователя.
имя секретаря	secretaryname	string	Имя секретаря пользователя.
секретарь	secretarymail	string	Электронная почта секретаря пользователя.
Кухни	specialities	string	Специальные особенности пользователя.
title	title	string	Заголовок пользователя.
погоня	goesby	string	предпочтительное имя пользователя.
суффикс	suffix	string	Суффикс имени пользователя.
atomlink	atomlink	string	Ссылка Atom, связанная с пользователем.
био	bio	string	Биография пользователя.
dateOfBirth	dateOfBirth	string	Дата рождения пользователя.
link	link	string	Ссылка, связанная с пользователем.
статус	status	string	Состояние пользователя.
Код состояния	statuscode	string	Код состояния пользователя.
сообщение	message	string	Сообщение, связанное с пользователем.
sourcetype	sourcetype	string	Тип источника пользователя.
orgid	orgid	string	Идентификатор организации.
ifpartner	ifpartner	string	Флаг партнера.
домен электронной почты	emaildomain	string	Домен электронной почты пользователя.
приглашение	invitationsent	string	Отправленный флаг приглашения.
Создание сайта	createdby	string	Пользователь, создавший запись.
createddate	createddate	string	Дата создания записи.
изменено	modifiedby	string	Пользователь, изменивший запись.
измененный откат	modifieddate	string	Дата изменения записи.
lastlogindate	lastlogindate	string	Дата последнего входа.
Invalidlogins	invalidlogins	string	Количество недопустимых попыток входа.
publicwebsiteprofileid	publicwebsiteprofileid	string	Идентификатор профиля общедоступного веб-сайта.
resetpassworddate	resetpassworddate	string	Дата сброса пароля.
аватар	avatar	string	URL-адрес изображения аватара.
следующая учетная запись	followingcount	integer	Количество отслеживаемых пользователей.
количество подписчиков	followercount	integer	Количество последователей.
следующий	following	boolean	Следующий флаг.
роль	role	string	Роль пользователя.
isbasicuser	isbasicuser	string	Базовый флаг пользователя.
encryptedUserId	encryptedUserId	string	Зашифрованный идентификатор пользователя.
саморегистрированное	selfregistered	integer	Саморегистрированное флаг.
registeredWith2FA	registeredWith2FA	string	Флаг регистрации двухфакторной проверки подлинности.
isInternal	isInternal	integer	Внутренний флаг пользователя.
orgName	orgName	string	Название организации.

сайт

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор сайта.
имя сайта	sitename	string	Название сайта.
роль	role	string	Роль сайта.
sitedescription	sitedescription	string	Описание сайта.
enabledmodules	enabledmodules	string	Список модулей, включенных для сайта.
sitefolderID	sitefolderID	string	Идентификатор папки сайта.
sitefolderpermission	sitefolderpermission	string	Уровень разрешений для папки сайта.
module	module	ModuleDBO
adminnote	adminnote	string	Административные заметки, связанные с сайтом.
startdate	startdate	string	Дата начала операции сайта.
enddate	enddate	string	Дата окончания операции сайта.
createddate	createddate	string	Дата создания сайта.
Archiveddate	archiveddate	string	Дата архивирования сайта.
clientno	clientno	string	Номер клиента, связанный с сайтом.
Matterno	matterno	string	Номер вопроса, связанный с сайтом.
целевая страница	landingpage	string	URL-адрес целевой страницы для сайта.
link	link	string	Ссылка, связанная с сайтом.
статус	status	string	Текущее состояние сайта.
statusid	statusid	integer	Идентификатор состояния сайта.
size	size	string	Размер сайта.
выставление счетов	billingnotes	string	Заметки, связанные с выставлением счетов для сайта.
billingnextinvoicedate	billingnextinvoicedate	string	Дата следующего счета для сайта.
billinglastinvoicedate	billinglastinvoicedate	string	Дата последнего счета для сайта.
filepagecount	filepagecount	string	Общее количество страниц файлов на сайте.
maxpagecount	maxpagecount	string	Максимально допустимое число страниц для файлов на сайте.
sitehttplink	sitehttplink	string	Http-ссылка на сайт.
isSyncable	isSyncable	integer	Указывает, можно ли синхронизировать сайт.
enforceusergroups	enforceusergroups	string	Группы пользователей, примененные для сайта.
csvSiteCategory	csvSiteCategory	string	Категория сайта в формате CSV.
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	Имя сайта на языке по умолчанию.
видимый	visible	integer	Указывает, отображается ли сайт.
siteLogoName	siteLogoName	string	Имя файла логотипа сайта.
siteLogoFileSize	siteLogoFileSize	integer	Размер файла логотипа сайта.
siteLogoHeight	siteLogoHeight	integer	Высота логотипа сайта.
siteLogoWidth	siteLogoWidth	integer	Ширина логотипа сайта.
siteStatus	siteStatus	integer	Код состояния сайта.
applySiteTerms	applySiteTerms	integer	Указывает, применяются ли условия сайта.
siteTerm	siteTerm	string	Термины, примененные к сайту.
termType	termType	integer	Тип терминов, применяемых к сайту.
nextLoginSiteTerms	nextLoginSiteTerms	integer	Указывает, требуются ли условия сайта для следующего входа.
defaultSiteTermsEnable	defaultSiteTermsEnable	integer	Указывает, включены ли термины сайта по умолчанию.
advancedQAPermission	advancedQAPermission	integer	Расширенный уровень разрешений QA для сайта.
isInternal	isInternal	integer	Указывает, является ли сайт внутренним.
psm	psm	integer	Идентификатор Product Service Manager.
siteLabelDisplay	siteLabelDisplay	string	Отображаемая метка для сайта.
allowSiteAdministration	allowSiteAdministration	integer	Указывает, разрешено ли администрирование сайта.
siteLevelPasswordEnable	siteLevelPasswordEnable	integer	Чтобы включить защиту паролей на уровне сайта.
siteLevelPasscodeEnable	siteLevelPasscodeEnable	integer	Чтобы включить защиту секретного кода на уровне сайта.
секретный кодUsingAuthApp	passcodeUsingAuthApp	integer	Указывает, используется ли проверка подлинности секретного кода приложением проверки подлинности.
sitePassword	sitePassword	string	Пароль, связанный с сайтом.
ipRestrictionEnable	ipRestrictionEnable	integer	Включение ограничений IP-адресов для доступа к сайту.
availableIP	availableIP	string	Разделенный запятыми список IP-адресов, разрешенных для доступа к сайту.
highqDrive	highqDrive	integer	Указывает, включена ли интеграция HighQ Drive.
applySiteHomePage	applySiteHomePage	integer	Чтобы применить настраиваемую домашнюю страницу для сайта.
siteHomePage	siteHomePage	string	URL-адрес пользовательской домашней страницы для сайта.
siteHomePageType	siteHomePageType	integer	Тип домашней страницы.
nextLoginSiteHomePage	nextLoginSiteHomePage	integer	Чтобы задать следующее имя входа на домашнюю страницу сайта.
applyDisplayContent	applyDisplayContent	integer	Применение параметров содержимого отображения.
displayContent	displayContent	string	Содержимое для отображения на сайте.
rssSecurity	rssSecurity	integer	Уровень безопасности RSS-канала.
encryptedPassword	encryptedPassword	integer	Указывает, зашифрован ли пароль сайта.
availableIPRangeCSV	availableIPRangeCSV	string	Разделенный запятыми список диапазонов IP-адресов, разрешенных для доступа к сайту.
siteModuleID	siteModuleID	integer	Идентификатор модуля сайта.
icalSecurity	icalSecurity	integer	Уровень безопасности веб-канала iCal.
defaultDisplayContent	defaultDisplayContent	string	Содержимое по умолчанию для отображения на сайте.
defaultEmailAlert	defaultEmailAlert	integer	Включение оповещений электронной почты по умолчанию.
excelReportFooter	excelReportFooter	integer	Включает нижний колонтитул в отчеты Excel.
excelReportFooterText	excelReportFooterText	string	Текст, отображаемый в нижнем колонтитуле отчетов Excel.
объявлениеMLJSON	announcementMLJSON	string	Объявления в формате JSON для сайта.
templateType	templateType	integer	Тип шаблона, используемого для сайта.
templateLicence	templateLicence	integer	Тип лицензии для шаблона сайта.
openChannelAppID	openChannelAppID	string	Идентификатор приложения для интеграции с открытым каналом.
itemid	itemid	integer	Идентификатор элемента, связанного с сайтом.
sitemetadatasheetid	sitemetadatasheetid	integer	Идентификатор листа метаданных, связанного с сайтом.
mysite	mysite	boolean	Указывает, является ли это персональным сайтом пользователя.
lastaccesseddate	lastaccesseddate	string	Дата и время последнего доступа к сайту.
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	Вкладка метаданных по умолчанию для средства просмотра веб-сайтов.
documentMetadataViewId	documentMetadataViewId	integer	метаданные документа для идентификатора представления.
folderMetadataViewId	folderMetadataViewId	integer	метаданные папки для идентификатора представления.
docSort	docSort	integer	Порядок сортировки документов.
folderSort	folderSort	integer	Порядок сортировки папок.
defaultFolderRenderView	defaultFolderRenderView	integer	Определяет режим представления по умолчанию для папок.
isTaskAttachmentDefault	isTaskAttachmentDefault	integer	Расположение по умолчанию для вложений задач.
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	Уникальный идентификатор папки, указанной в качестве расположения по умолчанию для вложений задач.
любимый	favourite	string	избранное состояние.
enabledocumentredaction	enabledocumentredaction	boolean	Указывает, включена ли редактирование документов для сайта.
упоминания групп	mentiongroups	integer	Упомянутые группы.
enablefilerelationships	enablefilerelationships	boolean	Указывает, включены ли связи файлов.
filerelationshipsitepermissionlevel	filerelationshipsitepermissionlevel	integer	Уровень разрешений, необходимый для управления связями файлов.

ModuleDBO

Имя	Путь	Тип
дом	home	HomeDBO
активность	activity	ActivityDBO
документ	document	DocumentDBO
Блог	blog	BlogDBO
вики	wiki	WikiDBO
задача	task	TaskDBO
событие	event	EventDBO
isheet	isheet	ISheetDBO
qa	qa	QaDBO
people	people	PeopleDBO
contractexpress	contractexpress	ContractExpressDBO

HomeDBO

Имя	Путь	Тип	Описание
включать	enable	string	Включение состояния для HomeDBO.

ActivityDBO

Имя	Путь	Тип	Описание
включать	enable	string	Включите состояние для ActivityDBO.
микроблог	microblog	string	Содержимое микроблога, связанное с ActivityDBO.

BlogDBO

Имя	Путь	Тип	Описание
blogTitle	blogTitle	string	Заголовок записи блога.
blogContent	blogContent	string	Содержимое записи блога.
showComment	showComment	integer	показать комментарий.
тегСписок	tagList	array of string	Список тегов, связанных с блогом.
статус	status	integer	состояние записи блога.
siteID	siteID	integer	Идентификатор связанного сайта.
автор	author	string	Автор блога.
categoryList	categoryList	array of string	Категории, назначенные записи блога.
notificationTypeID	notificationTypeID	integer	Идентификатор типа уведомления.
сообщение	message	string	Содержимое сообщения, связанное с блогом.
messageCode	messageCode	integer	Код, связанный с сообщением.
внешний идентификатор	externalID	string	Внешний идентификатор, связанный с блогом.
Дата публикации	publishDate	string	Дата публикации блога.
тип процесса	processtype	string	Тип процесса, связанный с блогом.
включать	enable	string	Включение состояния для BlogDBO.

WikiDBO

Имя	Путь	Тип	Описание
wikiid	wikiid	integer	Уникальный идентификатор вики-сайта.
currentversionid	currentversionid	integer	Идентификатор текущей версии вики-сайта
parentwikiid	parentwikiid	integer	Идентификатор родительского вики-сайта.
wikititle	wikititle	string	Название вики-сайта.
wikicontent	wikicontent	string	Содержимое вики-сайта.
showcomment	showcomment	integer	Указывает, включены ли примечания.
createddate	createddate	string	Дата создания вики-сайта.
измененный откат	modifieddate	string	Дата последнего изменения вики-сайта.
список тегов	taglist	string	Разделенный запятыми список тегов, связанных с вики-сайтом.
вики-path	wikipath	string	Путь к вики-сайту.
wikidraftid	wikidraftid	integer	Идентификатор черновика версии вики-сайта.
черновик	drafttype	string	Тип черновика, связанного с вики-сайтом.
статус	status	integer	Текущее состояние вики-сайта.
wikiversionid	wikiversionid	integer	Идентификатор версии вики-сайта.

TaskDBO

Имя	Путь	Тип	Описание
index	index	string	Индекс или идентификатор задачи.
parenttaskid	parenttaskid	integer	Идентификатор родительской задачи.
taskid	taskid	integer	Уникальный идентификатор задачи.
title	title	string	Заголовок задачи.
описание	description	string	Подробное описание задачи.
дуэт	duedate	string	Дата выполнения задачи.
startdate	startdate	string	Дата начала запуска задачи.
mattermaptaskid	mattermaptaskid	string	Идентификатор связывания с задачей карты материи.
type	type	string	Тип или категория задачи.
зависимый	dependenton	string	Задачи, от которые зависит эта задача.
daysfromdependent	daysfromdependent	string	Количество дней от зависимой задачи.
ignoreweekend	ignoreweekend	integer	Указывает, игнорируются ли выходные дни в планировании.
duration	duration	integer	Длительность выполнения задачи.
resource	resource	string	Ресурсы, назначенные задаче.

EventDBO

Имя	Путь	Тип	Описание
eventTitle	eventTitle	string	Название события.
eventContent	eventContent	string	Содержимое события.
showComment	showComment	integer	Указывает, включены ли комментарии для события.
тегСписок	tagList	array of string	Список тегов, связанных с событием.
статус	status	integer	Текущее состояние события.
siteID	siteID	integer	Идентификатор сайта.
контакт	contact	string	Контактные данные для события.
categoryList	categoryList	array of string	Категории, в которых отображается событие.
notificationTypeID	notificationTypeID	integer	Тип уведомления, связанный с событием.
сообщение	message	string	Сообщение события.
messageCode	messageCode	integer	Код сообщения события.
внешний идентификатор	externalID	string	Внешний идентификатор.
startDate	startDate	string	Дата начала события.
Дата окончания	endDate	string	Дата окончания события.
startTime	startTime	string	Время начала события.
endTime	endTime	string	Время окончания события.
location	location	string	Расположение события.
автор	author	string	Автор события.
тип процесса	processtype	string	Время процесса события.
включать	enable	string	Включите событие.

ISheetDBO

Имя	Путь	Тип	Описание
id	id	integer	Уникальный идентификатор для iSheet.
title	title	string	Заголовок iSheet.
описание	description	string	Описание листа.
статус	status	string	Состояние листа.
accesstype	accesstype	string	Тип доступа листа.
type	type	string	Тип листа.
viewlink	viewlink	string	Ссылка на просмотр iSheet.
разрешенные конфликты	allowsections	string	Разрешены ли разделы.
allowlookup	allowlookup	string	Включены ли поля подстановки.
displayisheet	displayisheet	string	Параметры отображения для iSheet.
searchasdefaultview	searchasdefaultview	string	Указывает, является ли поиск представлением по умолчанию.
enableversion	enableversion	string	Флаг включения управления версиями.
enablesheetalerter	enablesheetalerter	string	Пометка для включения оповещений листа.
alertercondition	alertercondition	string	Условия активации оповещений.
overrideitemmodifieddate	overrideitemmodifieddate	string	Переопределите измененный флаг даты.
enablebulkinsertupdate	enablebulkinsertupdate	string	Включите массовую вставку и обновление.
fielddescriptions	fielddescriptions	string	Описания полей для iSheet.
включение блокировки	enablerowlocking	string	Включите блокировку на уровне строк.
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	Усечение многострочного текстового флага.
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	Ограничение символов для многостроек усечения.
allowchoicelistvaluesforreuse	allowchoicelistvaluesforreuse	string	Разрешить повторное использование значений списка выбора.
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	Разрешить повторное использование значений списка показателей.
allowIsheetComments	allowIsheetComments	string	Разрешить комментарии в iSheet.
shareRecordsLimit	shareRecordsLimit	integer	Ограничение записей, разрешенных для общего доступа.
shareRecordsLimitEnabled	shareRecordsLimitEnabled	integer	Включено ограничение общего ресурса для записей.
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	Включите общий доступ к формам для добавления записей.
учетная запись	recordcount	string	Текущее число записей.
sheettypeid	sheettypeid	integer	Идентификатор типа iSheet

QaDBO

Имя	Путь	Тип	Описание
включать	enable	string	Включите функции QA.

PeopleDBO

Имя	Путь	Тип	Описание
Человек	person	array of PersonDBO

PersonDBO

Имя	Путь	Тип	Описание
userid	userid	integer	ИД пользователя
электронная почта	email	string	адрес электронной почты.
httpavatar	httpavatar	string	URL-адрес HTTP аватара.
аватар	avatar	string	Изображение аватара.
userlink	userlink	string	Ссылка на профиль пользователя.
httplink	httplink	string	HTTP-ссылка на профиль пользователя.
phone	phone	string	Номер телефона.
mobile	mobile	string	Мобильный номер.
отдел	department	string	Отдел пользователя.

ContractExpressDBO

Имя	Путь	Тип	Описание
включать	enable	string	Включение интеграции Contract Express.

FolderDBOV2

Имя	Путь	Тип	Описание
имя	name	string	Имя папки.
описание	description	string	Описание папки.
parentFolderID	parentFolderID	integer	Идентификатор родительской папки.
accessInherited	accessInherited	integer	Состояние наследования доступа.
batchID	batchID	string	Идентификатор пакетной службы
дмс	dms	DmsDBO
id	id	integer	Идентификатор папки.
link	link	string	Ссылка на папку.
createddate	createddate	string	Дата создания.
измененный откат	modifieddate	string	Дата изменения.
child	child	integer	Дочерние папки.
filecount	filecount	integer	Количество файлов.
Создание сайта	createdby	UserDBO
изменено	modifiedby	UserDBO
folderid	folderid	integer	Идентификатор папки.
dmsfolderid	dmsfolderid	string	Идентификатор папки DMS.
siteid	siteid	integer	Идентификатор сайта
location	location	string	Расположение папки.
разрешение	permission	PermissionDBO
contentstatus	contentstatus	integer	Состояние содержимого.
автоматическое число	autonumbering	string	Настройка автоматического нумерирования.
папка	foldersize	string	Размер папки.
sharedstatus	sharedstatus	integer	Состояние общего доступа.
избранное	favouritestatus	integer	Избранное состояние.
foldertype	foldertype	string	Тип папки.
идентификатор_элемента	itemId	integer	Идентификатор элемента.
folderMetadataSheetId	folderMetadataSheetId	integer	Метаданные папки идентификатора листа.

UserDBO

Имя	Путь	Тип	Описание
имя	firstname	string	Имя.
фамилия	lastname	string	Фамилия.
электронная почта	email	string	Адрес электронной почты.
userid	userid	integer	ИД пользователя

PermissionDBO

Имя	Путь	Тип	Описание
view	view	integer	Просмотр разрешений.
edit	edit	integer	Изменение разрешения.
delete	delete	integer	Удаление разрешения.
addEditAllFiles	addEditAllFiles	integer	Добавление и изменение разрешений всех файлов.
Администратора	admin	integer	Разрешение администратора.
viewAllFiles	viewAllFiles	integer	Просмотр всех файлов разрешения.
disableSave	disableSave	integer	отключите разрешение на сохранение.
uploadFile	uploadFile	integer	Разрешение на отправку файла.
updateFile	updateFile	integer	обновление разрешения файла.
deleteFile	deleteFile	integer	Удаление разрешения файла.

ProgressiveKeyDBO

Имя	Путь	Тип	Описание
прогрессивный ключ	progressivekey	string	Ключ для прогрессивных операций.
siteid	siteid	integer	Идентификатор сайта.
progressivekeystatus	progressivekeystatus	string	Состояние прогрессивного ключа.
userid	userid	integer	Идентификатор пользователя.
responsebody	responsebody	string	Текст ответа.
сообщение	message	string	Содержимое сообщения.
код сообщения	messagecode	string	Код, связанный с сообщением.
integrationResponseDBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheettemplate	importisheettemplate	importISheetTemplateDBO
ошибка	error	ErrorDBO
Тип контента	contentType	string	Тип содержимого.
FailedEntities	failedEntities	integer	Число неудачных сущностей.
downloadlink	downloadlink	string	Ссылка на скачивание содержимого.
прикрепление	attachment	Attachment
link	link	string	Связанная ссылка.
documentid	documentid	integer	Идентификатор документа.
Progresskey	progresskey	string	Ключ хода выполнения для отслеживания.
progresskeystatus	progresskeystatus	string	Состояние ключа хода выполнения.

IntegrationResponseDBO

Имя	Путь	Тип	Описание
integrationResponseUsersObject	integrationResponseUsersObject	IntegrationResponseUsersObject
FailedEntities	failedEntities	integer	Количество сущностей, которые не удалось обработать.
successEntities	successEntities	integer	Число сущностей, которые были успешно обработаны.

IntegrationResponseUsersObject

Имя	Путь	Тип	Описание
Пользователь	user	array of IntegrationUserDBO

ColumnErrorsDBO

Имя	Путь	Тип	Описание
столбец	column	array of ColumnErrorDBO
FailedEntities	failedEntities	integer	Количество сущностей, которые не удалось выполнить из-за ошибок столбцов.
successEntities	successEntities	integer	Число сущностей, которые были успешно обработаны.

ColumnErrorDBO

Имя	Путь	Тип	Описание
index	index	integer	Позиция индекса столбца с ошибкой.
columnid	columnid	integer	Уникальный идентификатор столбца с ошибкой.
имя	name	string	Имя столбца с ошибкой.
статус	status	string	Состояние, указывающее условие ошибки.
Код состояния	statuscode	string	Код, представляющий состояние ошибки.
сообщение	message	string	Подробное сообщение об ошибке.

ItemErrorsDBO

Имя	Путь	Тип	Описание
item	item	array of ItemErrorDBO
FailedEntities	failedEntities	integer	Количество сущностей, которые не удалось выполнить из-за ошибок элементов.
successEntities	successEntities	integer	Число сущностей, которые были успешно обработаны, несмотря на ошибки элементов.

ItemErrorDBO

Имя	Путь	Тип	Описание
index	index	integer	Положение индекса элемента с ошибкой.
columns	columns	ColumnErrorsDBO
itemid	itemid	string	Уникальный идентификатор элемента с ошибкой.
externalid	externalid	string	Внешний идентификатор, связанный с элементом.
id	id	string	Внутренний идентификатор элемента.
имя	name	string	Имя элемента с ошибкой.
статус	status	string	Состояние, указывающее условие ошибки.
Код состояния	statuscode	string	Код, представляющий состояние ошибки.
сообщение	message	string	Подробное сообщение об ошибке.
successdeletedcount	successdeletedcount	integer	Количество успешно удаленных сущностей.
сбой	failurecount	integer	Количество сущностей, которые не удалось обработать.
FailedEntities	failedEntities	integer	Количество сущностей, которые не удалось выполнить из-за ошибок элементов.
successEntities	successEntities	integer	Число сущностей, которые были успешно обработаны.

importISheetTemplateDBO

Имя	Путь	Тип	Описание
linkedtemplateid	linkedtemplateid	integer	Идентификатор связанного шаблона.
псевдоним	aliasname	string	Имя псевдонима шаблона.
linkedisheet	linkedisheet	string	Идентификатор связанного входного листа.
importdata	importdata	string	Данные, импортируемые из шаблона.
appendisheetname	appendisheetname	string	Имя листа для добавления данных.
templateparametergroups	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
идентификатор шаблона	templateId	integer	Идентификатор шаблона.
templateTitle	templateTitle	string	Заголовок шаблона.
ViewIDs	viewIDs	string	Разделенный запятыми список идентификаторов представлений.

ISheetTemplateParameterGroups

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

ISheetTemplateParameterGroup

Имя	Путь	Тип	Описание
templateruleid	templateruleid	integer	Группа параметров шаблона Isheet.
templateparameter	templateparameter	array of ISheetTemplateParameter

ISheetTemplateParameter

Имя	Путь	Тип	Описание
id	id	integer	Идентификатор параметра шаблона isheet.
имя	name	string	Имя параметра шаблона isheet.
данные	data	string	данные параметра шаблона isheet.

Вложение

Имя	Путь	Тип	Описание
file	file	string	Содержимое файла.
имя	name	string	Имя вложения.
заказ	order	string	Порядок вложения.
id	id	integer	Уникальный идентификатор для вложения.
Расширение	extension	string	Расширение файла.
parentfolderid	parentfolderid	integer	Идентификатор родительской папки.
filehttplink	filehttplink	string	HTTP-ссылка для доступа к файлу.
путь к папке	folderpath	string	Путь к папке, содержащей файл.
folderhttplink	folderhttplink	string	HTTP-ссылка на папку.
filesize	filesize	integer	Размер файла в байтах.
redactionStatus	redactionStatus	boolean	Указывает, редактируется ли файл.
displayname	displayname	string	Отображаемое имя вложения.
siteid	siteid	integer	Идентификатор сайта, связанного с вложением.

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

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

HighQ

Обзор

Authentication

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

Модуль ISheet

API ресурсов документа

API администрирования ISheet

Операции пользователя

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

Начало работы

Параметры и параметры

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

Дополнительные ресурсы

Лицензирование и поддержка

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

Действия

Архивный пользователь

Параметры

Добавить пользователя

Параметры

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

Добавление сайта

Параметры

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

Добавление существующей группы на сайт

Параметры

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

Обновление группы сайтов

Параметры

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

Обновление сайта

Параметры

Отправка файла

Параметры

Перемещение документов

Параметры

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

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

Параметры

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

Создание элемента iSheet

Параметры

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

Определения

ErrorDBO

DocumentDBO

columns

LocationDBO

Имя пользователя

MetadataListDBO

NameValueLink

Link

ExperiencesDBO

GroupsDBO

Пользователь

users

FolderDBOV1

DmsDBO

sitegroup

Address

IntegrationUserDBO