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

iManage Work

Соединитель iManage Work позволяет пользователям автоматизировать повторяющиеся задачи и процессы утверждения, сохраняя безопасность всех файлов в среде iManage Work.

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

Услуга 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)
Контакт
Имя iManage LLC
URL https://docs.imanage.com
Адрес электронной почты cloudsupport@imanage.com
Метаданные соединителя
Publisher Соединитель iManage Power Platform
Веб-сайт https://imanage.com
Политика конфиденциальности https://imanage.com/about/privacy-notice/
Категории Содержимое и файлы; Продуктивность

iManage Work

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

Предпосылки

Соединитель доступен для всех клиентов iManage Work, подключающихся к cloudimanage.com. Во-первых, приложению Power Automate потребуется включить администратор среды iManage Work. После включения вам потребуется конкретный URL-адрес среды и учетная запись входа и пароль, в которых соединитель может выполнять действия. Дополнительные сведения см. в разделе часто задаваемых вопросов.

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

Если вы являетесь существующим пользователем iManage Work, укажите учетные данные iManage Work для входа. В противном случае обратитесь к системному администратору за помощью.

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

Выполните следующие действия, чтобы приступить к работе с соединителем iManage Work:

  • Создайте мгновенный поток облака и нажмите кнопку +Создать шаг.
  • Найдите iManage Work , чтобы просмотреть все доступные действия iManage Work.
  • Выберите нужное действие iManage Work.
  • Если вы еще не вошли в iManage Work, вам будет предложено войти в систему.
    • Выберите Вход.
    • Введите URL-адрес, используемый для подключения к iManage Work, например cloudimanage.com.
    • Введите идентификатор пользователя iManage Work User.
    • Введите пароль для выбранной учетной записи и выберите "Войти". С этого момента все потоки, использующие действия iManage Work, подключаются с помощью этих учетных данных пользователя. Другую учетную запись пользователя iManage можно использовать, добавив новое подключение в разделе "Мои подключения" и переключившись на него.

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

Список известных проблем и ограничений см. в разделе https://docs.imanage.com/power-automate/index.html.

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

Список распространенных ошибок и средств защиты см. в статье https://docs.imanage.com/power-automate/index.html.

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

Список часто задаваемых вопросов см. в статье https://docs.imanage.com/power-automate/index.html.

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

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

Действия

Добавление записи журнала документов

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

Добавляет ссылку на документ или ярлык документа в другую папку.
Задание основных свойств расширенных метаданных в документе

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

Выполняет поиск значений основных расширенных таксономий метаданных, соответствующих указанным критериям поиска.
Изменение пар "имя-значение"

Создает, обновляет или удаляет свойства пары "имя-значение" документа, папки или рабочей области. Чтобы удалить пару "имя-значение", задайте значение ключа пустой строкой, завернутой в одинарные или двойные кавычки.
Копирование документа

Копирует документ в указанную папку.
копирование разрешений.

Копирует разрешения доступа и при необходимости безопасность по умолчанию из одного объекта iManage Work в другой. "Тип копирования" предоставляет варианты обработки сочетания разрешений источника и назначения. Функция Overwrite обновляет пользователей, групп и уровней разрешений целевого объекта, чтобы точно соответствовать исходному объекту. Merge сохраняет всех пользователей и групп в целевом объекте и объединяет их с источником, но в случае конфликта уровня разрешений для отдельного пользователя или группы: "Слияние (Pessimistic)" принимает более низкое разрешение, а "Слияние (оптимистично)" принимает более высокое разрешение для конфликтующего пользователя или группы.
Обновление безопасности по умолчанию

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

Выполняет обновления профиля документа. Документ не должен использоваться при обновлении его профиля, а профиль документа, извлеченного не может быть обновлен. Возвращает обновленный профиль документа после операции.
Обновление рабочей области

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

Обновляет разрешения объекта.
Обновление состояния рабочего процесса

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

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

Отправляет файл в виде нового документа в указанную папку.
Перемещение документа

Перемещает документ в указанную папку.
Повышение уровня версии документа

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

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

Выполняет поиск пользователей iManage Work, соответствующих указанным критериям поиска.
Поиск рабочих областей

Поиск рабочих областей.
Получение библиотек

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

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

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

Возвращает основные свойства расширенных метаданных документа.
Получение подклассов

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

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

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

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

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

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

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

Возвращает список шаблонов, доступных в библиотеке. Шаблон рабочей области — это предопределенная рабочая область, структура которой копируется для новой рабочей области.
Скачивание документа

Загружает версию определенного документа на основе идентификатора документа. Если последнее значение имеет значение true, скачиваются последние версии этого документа. Скачивание является потоком и не сохраняется локально.
Создание отношения документа

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

Создает новую рабочую область на основе выбранного шаблона. Шаблон рабочей области — это предопределенная рабочая область, структура которой копируется в новую рабочую область. Ограничения шаблона рабочей области автоматически применяются при создании новой рабочей области.
Удаление документа

Удаляет указанный документ.
Удаление отношения документа

Удаляет связь между указанными документами в библиотеке.
Удаление ссылки на документ

Удаляет ссылку на документ из указанной папки.

Добавление записи журнала документов

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

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

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Activity
 activity_code True integer

Указывает тип действия, выполняемого в документе.
Comments
 comments string

Указывает дополнительные сведения о действии.
Продолжительность
 duration integer

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

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

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

Добавление ссылки на документ

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

Добавляет ссылку на документ или ярлык документа в другую папку.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Идентификатор папки
 folderId True string

Указывает идентификатор папки. Например, "ACTIVE_US!773".

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

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

Указывает ссылку на документ и document_shortcut.
Wstype
 data.wstype string

Указывает тип объекта iManage Work. Возможные значения: document, document_shortcut, email.

Задание основных свойств расширенных метаданных в документе

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

Задает основные свойства расширенных метаданных в документе.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Имя
 key True string

Указывает имя свойства расширенных метаданных ядра.
Ценность
 value True string

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

Значения узла таксономии с расширением метаданных поиска

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

Выполняет поиск значений основных расширенных таксономий метаданных, соответствующих указанным критериям поиска.

Параметры

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

Указывает идентификатор библиотеки, в которой выполняется поиск.
Свойство таксономии
 taxonomyProperty True string

Указывает свойство таксономии, для которого выполняется поиск значений узлов.
Идентификатор
 id string

Указывает идентификатор отображения значения таксономии узла. Этот поиск не учитывает регистр. Частичные совпадения не поддерживаются.
Query
 query string

Задает запрос на сопоставление значений таксономии узлов с помощью подстановочного знака (*), предоставляя частичные совпадения для идентификатора отображения или описания.
Состояние узла
 enabled_state string

Указывает, чтобы возвращать только значения таксономии узлов, которые включены или отключены или оба.
Включить путь
 include_path boolean

Указывает, чтобы вернуть полный путь к значению соответствующего узла. Путь — это упорядоченный список, начинающийся с узла верхнего уровня в таксономии, а затем все узлы через ближайший родительский элемент соответствующего узла.
SSID узла-предка
 children_of_ssid string

Указывает уникальный системный идентификатор узла таксономии предка, чтобы ограничить поиск.
Только непосредственные дети
 immediate_children_only boolean

Указывает, чтобы ограничить результаты поиска прямыми потомками узла таксономии, заданного идентификатором SSID узла предка. Поиск может быть ограничен корневым уровнем таксономии, указав пустую строку для "SSID узла предка", упакованная в одинарные или двойные кавычки.

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

Имя Путь Тип Описание
SSID
 data.topMatchingResult.created_by.ssid string

Указывает уникальный системный идентификатор пользователя, создавшего значение верхнего соответствующего узла.
Дата создания
 data.topMatchingResult.create_date string

Указывает дату и время (в формате ISO 8601) созданное значение верхнего соответствующего узла.
Description
 data.topMatchingResult.description string

Указывает описание значения верхнего соответствующего узла.
SSID
 data.topMatchingResult.edited_by.ssid string

Указывает уникальный системный идентификатор пользователя, который последний раз редактировал значение верхнего соответствующего узла.
Дата редактирования
 data.topMatchingResult.edit_date string

Указывает дату и время (в формате ISO 8601) последнее изменение значения верхнего соответствующего узла.
Включен
 data.topMatchingResult.enabled boolean

Указывает, включено ли значение верхнего соответствующего узла.
Идентификатор
 data.topMatchingResult.id string

Указывает идентификатор отображения для значения верхнего соответствующего узла.
SSID
 data.topMatchingResult.parent.ssid string

Указывает уникальный идентификатор, созданный системой, для немедленного родительского узла значения верхнего соответствующего узла.
SSID
 data.topMatchingResult.ssid string

Указывает уникальный идентификатор, созданный системой, для значения верхнего соответствующего узла.
Путь
 data.topMatchingResult.path array of object

Указывает полный путь к значению верхнего соответствующего узла. Путь — это упорядоченный список, начинающийся с узла верхнего уровня в таксономии, а затем все узлы через ближайший родительский элемент соответствующего узла.
Каждый идентификатор
 data.topMatchingResult.path.id string

Указывает идентификатор отображения значения узла в пути к верхнему узлу.
Каждый SSID
 data.topMatchingResult.path.ssid string

Указывает уникальный системный идентификатор значения узла в пути к верхнему узлу.
Результаты поиска таксономии основных расширенных метаданных
 data.results array of TaxonomyNodeValue

Указывает одно или несколько основных расширенных значений таксономии метаданных, соответствующих поиску.
Все SSID узла таксономии
 data.all_taxonomy_ssids string

Указывает список всех SSID узла таксономии, объединенных как строку и разделенный точкой с запятой.

Изменение пар "имя-значение"

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Тип объекта
 objectType True string

Указывает тип объекта. Возможные значения: document, folder, workspace.
Код объекта
 objectId True string

Указывает идентификатор документа, папки или рабочей области. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".
Пары "Имя-значение"
 nameValuePairs object

Задает пары "Имя и значение" для этого документа.

Копирование документа

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

Копирует документ в указанную папку.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Идентификатор целевой папки
 folderId True string

Указывает идентификатор целевой папки, в которую необходимо скопировать документ. Например, "ACTIVE_US!987".

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

Имя Путь Тип Описание
Доступ к документам
 data.access string

Указывает набор разрешений уровня доступа для документа или контейнера. Уровень доступа устанавливается автором или пользователем с полным доступом к элементу. Возможные значения: "no_access", "read", "read_write", "full_access".
Псевдоним
 data.alias string

Указывает псевдоним этого документа.
Author
 data.author string

Указывает идентификатор пользователя, создавшего документ. Например, JSMITH.
Описание автора
 data.author_description string

Указывает дополнительные сведения о авторе документа.
Копия (Cc)
 data.cc string

Указывает получателей, которым копируется электронная почта. Применимо только к электронной почте.
Класс документа
 data.class string

Указывает класс документа.
Описание класса документа
 data.class_description string

Указывает дополнительные сведения о классе документов.
Тип контента
 data.content_type string

Указывает тип контента документа.
Дата создания документа
 data.create_date string

Указывает дату и время (в формате ISO 8601) документ был импортирован в систему iManage Work. Эта дата может отличаться от "file_create_date".
База данных
 data.database string

Указывает библиотеку, в которой хранится документ.
Безопасность документа по умолчанию
 data.default_security string

Указывает уровень доступа по умолчанию. Возможные значения: "наследование", "private", "view", "public".
Номер документа
 data.document_number integer

Указывает номер документа.
URL-адрес документа
 data.document_url string

Указывает ссылку, доступную для общего доступа для документа.
Дата редактирования документа
 data.edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения документа.
Дата изменения профиля
 data.edit_profile_date string

Указывает дату и время (в формате ISO 8601) последнего изменения профиля документа.
Расширение документа
 data.extension string

Указывает расширение имени файла, которое также называется расширением приложения.
Дата создания файла
 data.file_create_date string

Указывает дату и время (в формате ISO 8601) созданный файл. Возможно, файл был создан за пределами системы iManage Work. Эта дата может отличаться от "create_date".
Дата редактирования файла
 data.file_edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения файла. Файл, возможно, был изменен перед отправкой в систему iManage Work.
От
 data.from string

Указывает отправителя сообщения электронной почты. Применимо только к электронной почте.
Полное имя файла
 data.full_file_name string

Указывает полное имя файла документа. Включает расширение имени файла.
Имеет вложение
 data.has_attachment boolean

Указывает, есть ли вложения электронной почты. Применимо только к электронной почте.
Основные свойства документа
 data.basic_properties string

Указывает внедренный элемент "", содержащий базовые свойства документа.
Идентификатор документа
 data.id string

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Индексируется
 data.indexable boolean

Указывает, индексируется ли документ системой.
Извлечено
 data.is_checked_out boolean

Указывает, извлекается ли документ.
Объявлен
 data.is_declared boolean

Указывает, объявлен ли документ как запись. Документ, объявленный как запись, не может быть изменен или удален, за исключением системного администратора iManage Work.
Внешний
 data.is_external boolean

Указывает, предоставлен ли документ внешним пользователям.
Внешний как обычный
 data.is_external_as_normal boolean

Указывает, является ли документ внешним как нормальным.
Is HIPAA
 data.is_hipaa boolean

Указывает, зашифрован ли документ.
Используется
 data.is_in_use boolean

Указывает, используется ли документ.
Ссылка на документ
 data.iwl string

Указывает ссылку на iManage Work Link (iWL) для документа. IWL используется для открытия документа в режиме защищенного представления пользователем, у которого есть "read_write" или "full_access".
Последний пользователь
 data.last_user string

Указывает идентификатор пользователя, который редактировал документ в последнее время. Например, JSMITH.
Последнее описание пользователя
 data.last_user_description string

Указывает дополнительные сведения о последнем пользователе, который редактировал документ в последнее время.
Имя документа
 data.name string

Указывает имя файла документа.
Operator
 data.operator string

Указывает идентификатор пользователя, который извлечен документ или в настоящее время редактирует свой профиль. Например, JSMITH.
Описание оператора
 data.operator_description string

Указывает дополнительные сведения о операторе.
Дата получения
 data.received_date string

Указывает дату и время (в формате ISO 8601) полученное сообщение электронной почты. Применимо только к электронной почте.
Хранение дней
 data.retain_days integer

Указывает количество дней до того, как документ может быть архивированием. Применимо только к неактивным документам.
Дата отправки
 data.sent_date string

Указывает дату и время (в формате ISO 8601) отправлено сообщение электронной почты. Применимо только к электронной почте.
Размер документа
 data.size integer

Указывает размер документа в байтах.
Подкласс
 data.subclass string

Указывает подкласс документа.
Описание подкласса
 data.subclass_description string

Указывает дополнительные сведения о подклассе документа.
Кому
 data.to string

Указывает получателя сообщения электронной почты. Применимо только к электронной почте.
Тип
 data.type string

Указывает тип документа. Например, WORD для Microsoft Word. Для текущего списка типов обратитесь к системному администратору iManage Work.
Описание типа
 data.type_description string

Указывает дополнительные сведения о типе документа.
Версия документа
 data.version integer

Указывает номер версии документа.
Идентификатор рабочей области
 data.workspace_id string

Указывает идентификатор рабочей области документа. Например, "ACTIVE_US!427".
Имя рабочей области
 data.workspace_name string

Указывает имя рабочей области документа.
Wstype
 data.wstype string

Указывает тип объекта iManage Work. Возможные значения: "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user".
Custom13
 data.custom13 string

Указывает значение custom13.
Custom14
 data.custom14 string

Указывает значение custom14.
Custom15
 data.custom15 string

Указывает значение custom15.
Custom16
 data.custom16 string

Указывает значение custom16.
Custom21
 data.custom21 string

Указывает значение свойства custom21 в формате даты и времени ISO 8601.
Custom22
 data.custom22 string

Указывает значение свойства custom22 в формате даты и времени ISO 8601.

копирование разрешений.

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

Копирует разрешения доступа и при необходимости безопасность по умолчанию из одного объекта iManage Work в другой. "Тип копирования" предоставляет варианты обработки сочетания разрешений источника и назначения. Функция Overwrite обновляет пользователей, групп и уровней разрешений целевого объекта, чтобы точно соответствовать исходному объекту. Merge сохраняет всех пользователей и групп в целевом объекте и объединяет их с источником, но в случае конфликта уровня разрешений для отдельного пользователя или группы: "Слияние (Pessimistic)" принимает более низкое разрешение, а "Слияние (оптимистично)" принимает более высокое разрешение для конфликтующего пользователя или группы.

Параметры

Имя Ключ Обязательно Тип Описание
Тип исходного объекта
 sourceObjectType True string

Указывает тип исходного объекта.
Идентификатор исходного объекта
 sourceObjectId True string

Указывает идентификатор объекта, из которого копируются разрешения. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".
Тип целевого объекта
 targetObjectType True string

Указывает тип целевого объекта.
Идентификатор целевого объекта
 targetObjectId True string

Указывает идентификатор объекта, в который копируются разрешения. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".
Тип копирования
 copyType True string

Указывает, чтобы объединить разрешения исходного объекта с разрешениями целевого объекта или перезаписать разрешения целевого объекта с разрешениями источника. Дополнительные сведения см. в описании действия.
Копирование безопасности по умолчанию
 copyDefaultSecurity True boolean

Указывает, чтобы скопировать безопасность исходного объекта по умолчанию в целевой объект. Если безопасность исходного объекта по умолчанию является "наследуемой", то наследуемая безопасность по умолчанию копируется из источника в целевой объект.

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

Тело
UpdatePermissionsResponse

Обновление безопасности по умолчанию

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Тип объекта
 objectType True string

Указывает тип объекта.
Код объекта
 objectId True string

Указывает идентификатор документа, папки или рабочей области. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".
Безопасность по умолчанию
 default_security True string

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

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

Имя Путь Тип Описание
Безопасность по умолчанию
 data.default_security string

Указывает безопасность объекта по умолчанию. Возможные значения: "наследование", "public", "view" или "private".
Разрешения доступа
 data.acl AccessPermissions

Указывает коллекцию разрешений доступа для одного или нескольких пользователей и (или) групп.

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

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Псевдоним
 alias string

Указывает псевдоним этого документа.
Author
 author string

Указывает идентификатор пользователя, создавшего документ. Например, JSMITH.
Комментарий
 comment string

Указывает дополнительные сведения о документе.
Безопасность документа по умолчанию
 default_security string

Указывает уровень доступа по умолчанию.
Идентификатор документа
 documentId True string

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Объявлен
 is_declared boolean

Указывает, должен ли документ быть объявлен как запись. Документ, объявленный как запись, не может быть изменен или удален, за исключением системного администратора iManage Work.
Is HIPAA
 is_hipaa boolean

Указывает, следует ли шифровать документ.
Комментарий аудита
 audit_comment string

Указывает дополнительные сведения об обновлении профиля документа.
Класс документа
 class string

Указывает класс документа.
Имя документа
 name string

Указывает имя файла документа.
Operator
 operator string

Указывает идентификатор пользователя, который извлек документ или в настоящее время редактирует профиль документа. Например, JSMITH.
Хранение дней
 retain_days integer

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

Указывает подкласс документа.
Custom1
 custom1 string

Указывает значение custom1.
Custom2
 custom2 string

Задает значение custom2. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний".
Custom3
 custom3 string

Указывает значение custom3.
Custom4
 custom4 string

Указывает значение custom4.
Custom5
 custom5 string

Указывает значение custom5.
Custom6
 custom6 string

Задает значение custom6.
Custom7
 custom7 string

Указывает значение custom7.
Custom8
 custom8 string

Задает значение custom8.
Custom9
 custom9 string

Задает значение custom9.
Custom10
 custom10 string

Указывает значение custom10.
Custom11
 custom11 string

Указывает значение custom11.
Custom12
 custom12 string

Задает значение custom12.
Custom13
 custom13 string

Задает значение custom13.
Custom14
 custom14 string

Указывает значение custom14.
Custom15
 custom15 string

Задает значение custom15.
Custom16
 custom16 string

Указывает значение custom16.
Custom17
 custom17 double

Указывает значение custom17.
Custom18
 custom18 double

Задает значение custom18.
Custom19
 custom19 double

Указывает значение custom19.
Custom20
 custom20 double

Задает значение custom20.
Custom21
 custom21 string

Задает значение свойства custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение свойства custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение свойства custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение настраиваемого свойства 24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение custom25.
Custom26
 custom26 boolean

Указывает значение custom26.
Custom27
 custom27 boolean

Задает значение custom27.
Custom28
 custom28 boolean

Указывает значение custom28.
Custom29
 custom29 string

Задает значение custom29.
Custom30
 custom30 string

Указывает значение custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".

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

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

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

Параметры

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

Указывает идентификатор обновляемой рабочей области. Например, "ACTIVE_US!427".
Имя
 name string

Указывает имя рабочей области.
Владелец рабочей области
 owner string

Указывает владельца рабочей области.
Custom1
 custom1 string

Указывает значение custom1.
Custom2
 custom2 string

Задает значение custom2. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний".
Custom3
 custom3 string

Указывает значение custom3.
Custom4
 custom4 string

Указывает значение custom4.
Custom5
 custom5 string

Указывает значение custom5.
Custom6
 custom6 string

Задает значение custom6.
Custom7
 custom7 string

Указывает значение custom7.
Custom8
 custom8 string

Задает значение custom8.
Custom9
 custom9 string

Задает значение custom9.
Custom10
 custom10 string

Указывает значение custom10.
Custom11
 custom11 string

Указывает значение custom11.
Custom12
 custom12 string

Задает значение custom12.
Custom13
 custom13 string

Задает значение custom13.
Custom14
 custom14 string

Указывает значение custom14.
Custom15
 custom15 string

Задает значение custom15.
Custom16
 custom16 string

Указывает значение custom16.
Custom17
 custom17 double

Указывает значение custom17.
Custom18
 custom18 double

Задает значение custom18.
Custom19
 custom19 double

Указывает значение custom19.
Custom20
 custom20 double

Задает значение custom20.
Custom21
 custom21 string

Задает значение custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение custom24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение custom25.
Custom26
 custom26 boolean

Указывает значение custom26.
Custom27
 custom27 boolean

Задает значение custom27.
Custom28
 custom28 boolean

Указывает значение custom28.
Custom29
 custom29 string

Задает значение custom29.
Custom30
 custom30 string

Указывает значение custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию.
Description
 description string

Указывает дополнительные сведения о рабочей области.
Внешний как обычный
 is_external_as_normal boolean

Указывает, может ли рабочая область рассматриваться как общедоступная рабочая область. Если задано значение "true" и "default_security" не является "частным", значение "is_external" имеет значение true.
Project Custom1
 project_custom1 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Project Custom2
 project_custom2 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Project Custom3
 project_custom3 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Подкласс рабочей области
 subclass string

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

Обновление разрешений

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

Обновляет разрешения объекта.

Параметры

Имя Ключ Обязательно Тип Описание
Тип объекта
 objectType True string

Указывает тип объекта.
Код объекта
 objectId True string

Указывает идентификатор документа, папки или рабочей области. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".
Уровень доступа
 access_level True string

Указывает уровень доступа.
Users
 users string

Задает один или несколько пользователей для задания уровня доступа, разделенного точкой с запятой.
Groups
 groups string

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

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

Тело
UpdatePermissionsResponse

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

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

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

Параметры

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

Указывает идентификатор библиотеки, для которой определен рабочий процесс.
Государство
 state True string

Указывает текущее состояние выполнения рабочего процесса.
Состояние
 status string

Указывает текущее состояние выполнения рабочего процесса. Максимальная длина — 128 символов.
Сообщение о состоянии
 statusMessage string

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

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

response
object

Обновление текущей или создания новой версии документа

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Обновление или создание новой версии
 updateOrCreate True string

Указывает, чтобы обновить текущую версию документа или создать новую версию.
Существующий идентификатор документа
 documentId True string

Указывает идентификатор существующего документа. Например, "ACTIVE_US!556.1".
Сохранение блокировки
 keep_locked boolean

Указывает, хранится ли блокировка документа после отправки.
Комментарий
 comment string

Указывает дополнительные сведения об обновлении.
Имя документа
 name string

Указывает имя документа.
Author
 author string

Указывает идентификатор работы iManage пользователя, создавшего документ.
Operator
 operator string

Указывает идентификатор пользователя, который извлечен документ или в настоящее время редактирует профиль документа. Например, JSMITH.
Class
 class string

Задает класс для идентификации и различения документа. Класс документов разделен на жанр, отдел, регион и т. д.
Подкласс
 subclass string

Задает подкласс для идентификации и различения документа. Подкласс документа класс классируется по жанру, отделу, региону и т. д.
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию. Возможные значения: "наследование", "private", "view", "public".
Is HIPAA
 is_hipaa boolean

Указывает, следует ли шифровать документ.
Хранение дней
 retain_days integer

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

Указывает содержимое файла.
Дата создания файла
 file_create_date date-time

Указывает дату и время (в формате ISO 8601) созданный файл. Возможно, файл был создан за пределами системы iManage Work. Эта дата может отличаться от "create_date". Create_date — это дата создания или импорта файла системой iManage Work.
Дата редактирования файла
 file_edit_date date-time

Указывает дату и время (в формате ISO 8601) последнего изменения файла. Файл можно было изменить перед отправкой в систему iManage Work.
Custom1
 custom1 string

Указывает значение для custom1.
Custom2
 custom2 string

Указывает значение для custom2. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний".
Custom3
 custom3 string

Задает значение для custom3.
Custom4
 custom4 string

Задает значение для custom4.
Custom5
 custom5 string

Задает значение для custom5.
Custom6
 custom6 string

Указывает значение для custom6.
Custom7
 custom7 string

Задает значение для custom7.
Custom8
 custom8 string

Задает значение для custom8.
Custom9
 custom9 string

Задает значение для custom9.
Custom10
 custom10 string

Задает значение для custom10.
Custom11
 custom11 string

Указывает значение для custom11.
Custom12
 custom12 string

Задает значение для custom12.
Custom13
 custom13 string

Указывает значение для custom13.
Custom14
 custom14 string

Задает значение для custom14.
Custom15
 custom15 string

Задает значение для custom15.
Custom16
 custom16 string

Задает значение для custom16.
Custom17
 custom17 double

Задает значение для custom17.
Custom18
 custom18 double

Задает значение для custom18.
Custom19
 custom19 double

Задает значение для custom19.
Custom20
 custom20 double

Указывает значение для custom20.
Custom21
 custom21 string

Задает значение для custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение для custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение для custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение для custom24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение для custom25.
Custom26
 custom26 boolean

Задает значение для custom26.
Custom27
 custom27 boolean

Задает значение для custom27.
Custom28
 custom28 boolean

Задает значение для custom28.
Custom29
 custom29 string

Задает значение для custom29.
Custom30
 custom30 string

Задает значение для custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".

Отправка документа

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

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

Параметры

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

Указывает идентификатор целевой библиотеки.
Идентификатор папки
 folderId True string

Указывает идентификатор папки целевой папки. Например, "ACTIVE_US!987".
Наследование профиля папки
 inherit_profile_from_folder True boolean

Указывает, наследуется ли данные профиля из родительской папки.
Сохранение блокировки
 keep_locked boolean

Указывает, хранится ли блокировка документа после отправки.
Комментарий
 comment string

Указывает дополнительные сведения об обновлении.
Author
 author string

Указывает идентификатор работы iManage пользователя, создавшего документ.
Operator
 operator string

Указывает идентификатор пользователя, который извлечен документ или в настоящее время редактирует профиль документа. Например, JSMITH.
Class
 class string

Задает класс для идентификации и различения документа. Класс документов разделен на жанр, отдел, регион и т. д.
Подкласс
 subclass string

Задает подкласс для идентификации и различения документа. Подкласс документа класс классируется по жанру, отделу, региону и т. д.
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию. Возможные значения: "наследование", "private", "view", "public".
Is HIPAA
 is_hipaa boolean

Указывает, следует ли шифровать документ.
Хранение дней
 retain_days integer

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

Указывает содержимое файла.
Дата создания файла
 file_create_date date-time

Указывает дату и время (в формате ISO 8601) созданный файл. Возможно, файл был создан за пределами системы iManage Work. Эта дата может отличаться от "create_date". Create_date — это дата создания или импорта файла системой iManage Work.
Дата редактирования файла
 file_edit_date date-time

Указывает дату и время (в формате ISO 8601) последнего изменения файла. Файл можно было изменить перед отправкой в систему iManage Work.
Custom1
 custom1 string

Указывает значение для custom1.
Custom2
 custom2 string

Указывает значение для custom2. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний".
Custom3
 custom3 string

Задает значение для custom3.
Custom4
 custom4 string

Задает значение для custom4.
Custom5
 custom5 string

Задает значение для custom5.
Custom6
 custom6 string

Указывает значение для custom6.
Custom7
 custom7 string

Задает значение для custom7.
Custom8
 custom8 string

Задает значение для custom8.
Custom9
 custom9 string

Задает значение для custom9.
Custom10
 custom10 string

Задает значение для custom10.
Custom11
 custom11 string

Указывает значение для custom11.
Custom12
 custom12 string

Задает значение для custom12.
Custom13
 custom13 string

Указывает значение для custom13.
Custom14
 custom14 string

Задает значение для custom14.
Custom15
 custom15 string

Задает значение для custom15.
Custom16
 custom16 string

Задает значение для custom16.
Custom17
 custom17 double

Задает значение для custom17.
Custom18
 custom18 double

Задает значение для custom18.
Custom19
 custom19 double

Задает значение для custom19.
Custom20
 custom20 double

Указывает значение для custom20.
Custom21
 custom21 string

Задает значение для custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение для custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение для custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение для custom24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение для custom25.
Custom26
 custom26 boolean

Задает значение для custom26.
Custom27
 custom27 boolean

Задает значение для custom27.
Custom28
 custom28 boolean

Задает значение для custom28.
Custom29
 custom29 string

Задает значение для custom29.
Custom30
 custom30 string

Задает значение для custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".

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

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

Перемещает документ в указанную папку.

Параметры

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

Указывает идентификатор папки родительской папки. Например, "ACTIVE_US!987".
Идентификатор документа
 documentId True string

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Идентификатор целевой папки
 destination_folder_id True string

Указывает идентификатор целевой папки, в которую необходимо переместить документ. Например, "ACTIVE_US!987".
Применение профиля назначения
 update_profile boolean

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

Указывает, следует ли обновлять безопасность документов с помощью безопасности целевой папки. Этот параметр применяется только в том случае, если для профиля обновления задано значение true.
Комментарии временной шкалы
 comments string

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

Повышение уровня версии документа

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

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

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Версия
 version integer

Указывает номер версии, используемый в качестве основы для новой, повышенной версии.
Идентификатор журнала
 journalId string

Указывает идентификатор журнала, используемый в качестве основы для новой, повышенной версии.
Комментарий
 comment string

Указывает дополнительные сведения о документе.
Псевдоним
 alias string

Указывает псевдоним этого документа.
Author
 author string

Указывает идентификатор пользователя, создавшего документ. Например, JSMITH.
Класс документа
 class string

Указывает класс документа.
Безопасность документа по умолчанию
 default_security string

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

Указывает, должна ли быть объявлена новая версия документа как запись. Документ, объявленный как запись, не может быть изменен или удален, за исключением системного администратора iManage Work.
Is HIPAA
 is_hipaa boolean

Указывает, должна ли быть зашифрована новая версия документа.
Имя документа
 name string

Указывает имя файла документа.
Operator
 operator string

Указывает идентификатор пользователя, который извлечен документ или в настоящее время редактирует профиль документа. Например, JSMITH.
Хранение дней
 retain_days integer

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

Указывает подкласс документа.
Custom1
 custom1 string

Указывает значение custom1.
Custom2
 custom2 string

Задает значение custom2. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний".
Custom3
 custom3 string

Указывает значение custom3.
Custom4
 custom4 string

Указывает значение custom4.
Custom5
 custom5 string

Указывает значение custom5.
Custom6
 custom6 string

Задает значение custom6.
Custom7
 custom7 string

Указывает значение custom7.
Custom8
 custom8 string

Задает значение custom8.
Custom9
 custom9 string

Задает значение custom9.
Custom10
 custom10 string

Указывает значение custom10.
Custom11
 custom11 string

Указывает значение custom11.
Custom12
 custom12 string

Задает значение custom12.
Custom13
 custom13 string

Задает значение custom13.
Custom14
 custom14 string

Указывает значение custom14.
Custom15
 custom15 string

Задает значение custom15.
Custom16
 custom16 string

Указывает значение custom16.
Custom17
 custom17 double

Указывает значение custom17.
Custom18
 custom18 double

Задает значение custom18.
Custom19
 custom19 double

Указывает значение custom19.
Custom20
 custom20 double

Задает значение custom20.
Custom21
 custom21 string

Задает значение свойства custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение свойства custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение свойства custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение настраиваемого свойства 24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение custom25.
Custom26
 custom26 boolean

Указывает значение custom26.
Custom27
 custom27 boolean

Задает значение custom27.
Custom28
 custom28 boolean

Указывает значение custom28.
Custom29
 custom29 string

Задает значение custom29.
Custom30
 custom30 string

Указывает значение custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".

Поиск папок

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

Поиск папок.

Параметры

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

Указывает идентификатор библиотеки целевой папки.
Идентификатор контейнера
 container_id string

Указывает идентификатор рабочей области или папки, из которой следует возвращать папки. Например, "ACTIVE_US!987". Если этот параметр указан, он возвращает папки только из указанной рабочей области или папки.
Описание папки
 description string

Указывает значение, которое нужно найти в свойстве описания папки. Этот поиск не учитывает регистр. Поддерживаются частичные совпадения.
Адрес электронной почты папки
 email string

Указывает адрес электронной почты, соответствующий адресу электронной почты папки. Например, 'email1234@ajubalaw.com'.
Имя папки
 name string

Указывает значение, которое нужно найти в свойстве имени папки. Этот поиск не учитывает регистр. Поддерживаются частичные совпадения.
Владелец папки
 owner string

Указывает строку, соответствующую владельцу, связанному с папкой. Этот поиск не учитывает регистр. Поддерживаются частичные совпадения.
Имя рабочей области
 workspace_name string

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

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

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

Выполняет поиск пользователей iManage Work, соответствующих указанным критериям поиска.

Параметры

Имя Ключ Обязательно Тип Описание
Код электронной почты
 email string

Указывает идентификатор электронной почты для поиска. Например, 'JSMITH@XYZ.COM'.

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

Имя Путь Тип Описание
Разрешить вход
 data.topMatchingUser.allow_logon boolean

Указывает, разрешен ли пользователю входить в систему.
Custom1
 data.topMatchingUser.custom1 string

Указывает дополнительные сведения о пользователе.
Custom2
 data.topMatchingUser.custom2 string

Указывает дополнительные сведения о пользователе.
Custom3
 data.topMatchingUser.custom3 string

Указывает дополнительные сведения о пользователе.
Код каталога
 data.topMatchingUser.directory_id string

Указывает идентификатор внешнего каталога (например, ADFS), который используется для синхронизации профилей пользователей.
Различающееся имя
 data.topMatchingUser.distinguished_name string

Указывает имя объекта, представляющего полный путь к именам, которые трассирует запись обратно в корень дерева LDAP.
Дата редактирования
 data.topMatchingUser.edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения профиля пользователя.
Адрес электронной почты
 data.topMatchingUser.email string

Указывает идентификатор электронной почты пользователя.
URL-адрес автоматического обнаружения Exchange
 data.topMatchingUser.exch_autodiscover string

Указывает сведения о сервере Exchange пользователя.
Extension
 data.topMatchingUser.extension string

Указывает расширение номера телефона пользователя.
Неудачные попытки входа
 data.topMatchingUser.failed_logins integer

Указывает текущее количество неудачных попыток входа пользователя.
Факс
 data.topMatchingUser.fax string

Указывает номер факса пользователя.
Принудительное изменение пароля
 data.topMatchingUser.force_password_change boolean

Указывает, что пользователь должен изменить пароль при следующем входе. Применимо только к виртуальным пользователям, указанным значением "user_nos" "2".
Полное имя
 data.topMatchingUser.full_name string

Указывает полное имя пользователя.
General
 data.topMatchingUser.general string

Указывает общие сведения о пользователе.
Идентификатор
 data.topMatchingUser.id string

Указывает идентификатор пользователя. Например, JSMITH.
Внешний
 data.topMatchingUser.is_external boolean

Указывает внешнего пользователя. Внешний пользователь имеет ограниченный доступ и обычно используется для временных членов группы, консультантов или внешних для организации.
Время последней синхронизации
 data.topMatchingUser.last_sync_ts string

Указывает время последней синхронизации (в формате даты и времени ISO 8601) профиля пользователя с внешним каталогом, например LDAP или Microsoft Active Directory (ADFS).
Местоположение
 data.topMatchingUser.location string

Указывает географическое расположение пользователя.
Срок действия пароля никогда не истекает
 data.topMatchingUser.password_never_expire boolean

Указывает, не истекает ли срок действия пароля пользователя.
Номер телефона
 data.topMatchingUser.phone string

Указывает номер телефона пользователя.
Предпочтительная библиотека
 data.topMatchingUser.preferred_library string

Указывает предпочтительную библиотеку. Предпочтительная библиотека — это библиотека по умолчанию пользователя. У каждого пользователя должна быть одна предпочтительная библиотека.
Время изменения пароля
 data.topMatchingUser.pwd_changed_ts string

Указывает время (в формате даты и времени ISO 8601) при последнем изменении пароля пользователя. Это применимо только к виртуальным пользователям (чей пользователь NOS равен 2).
SSID
 data.topMatchingUser.ssid string

Указывает уникальный системный идентификатор пользователя.
Домен
 data.topMatchingUser.user_domain string

Указывает полное доменное имя для службы каталогов пользователя.
Расширенный идентификатор
 data.topMatchingUser.user_id_ex string

Указывает исходное значение идентификатора пользователя, полученного из внешнего каталога, например Microsoft Active Directory (ADFS).
NOS
 data.topMatchingUser.user_nos integer

Указывает тип операционной системы, из которой синхронизируется пользователь. Возможные значения: 2 (виртуальный пользователь) и 6 (корпоративный пользователь). Для получения дополнительной информации обратитесь к системному администратору iManage Work.
Number
 data.topMatchingUser.user_num integer

Указывает числовой идентификатор системы пользователя.
results
 data.results array of UserProfileInArray

Поиск рабочих областей

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

Поиск рабочих областей.

Параметры

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

Указывает идентификатор библиотеки целевой рабочей области.
Название
 name string

Указывает строку для поиска в свойстве имени рабочей области. Этот поиск не учитывает регистр.
Владелец
 owner string

Указывает строку, соответствующую владельцу, связанному с рабочей областью. Этот поиск не учитывает регистр.
Keyword
 anywhere string

Указывает текст для поиска в любом месте профиля рабочей области. Этот поиск не учитывает регистр.
Description
 description string

Указывает текст для поиска в свойстве описания рабочей области. Этот поиск не учитывает регистр.
Подкласс
 subclass string

Указывает значение, соответствующее значению подкласса, связанному с рабочей областью. Этот поиск не учитывает регистр.
Custom1
 custom1 string

Указывает значение, соответствующее пользовательскому значению1, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom2
 custom2 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom3
 custom3 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom4
 custom4 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom5
 custom5 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom6
 custom6 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom7
 custom7 string

Указывает значение, соответствующее пользовательскому значению7, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom8
 custom8 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom9
 custom9 string

Указывает значение, соответствующее пользовательскому значению, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom10
 custom10 string

Указывает значение, соответствующее пользовательскому значению10, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom11
 custom11 string

Указывает значение, соответствующее пользовательскому значению11, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom12
 custom12 string

Указывает значение, соответствующее пользовательскому значению12, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom13
 custom13 string

Указывает значение, соответствующее пользовательскому значению13, связанному с рабочей областью. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Custom14
 custom14 string

Указывает значение, соответствующее пользовательскому значению14, связанному с рабочей областью. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Custom15
 custom15 string

Указывает значение, соответствующее пользовательскому значению15, связанному с рабочей областью. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Custom16
 custom16 string

Указывает значение, соответствующее пользовательскому значению16, связанному с рабочей областью. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Custom17
 custom17 string

Указывает значение, соответствующее пользовательскому значению17, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom18
 custom18 string

Указывает значение, соответствующее пользовательскому значению18, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom19
 custom19 string

Указывает значение, соответствующее пользовательскому значению19, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom20
 custom20 string

Указывает значение, соответствующее пользовательскому значению20, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom21 (нижнее ограничение)
 custom21_from string

Указывает нижний предел (в формате даты и времени ISO 8601), чтобы найти в свойстве custom21, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom21 (верхний предел)
 custom21_to string

Задает верхний предел (в формате даты и времени ISO 8601) для поиска в свойстве custom21, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom22 (нижнее ограничение)
 custom22_from string

Задает нижнее ограничение (в формате даты и времени ISO 8601), чтобы найти в свойстве custom22, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom22 (верхний предел)
 custom22_to string

Указывает верхний предел (в формате даты и времени ISO 8601) для поиска в свойстве custom22, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom23 (нижнее ограничение)
 custom23_from string

Задает нижний предел (в формате даты и времени ISO 8601), чтобы найти в свойстве custom23, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom23 (верхний предел)
 custom23_to string

Задает верхний предел (в формате даты и времени ISO 8601) для поиска в свойстве custom23, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom24 (нижнее ограничение)
 custom24_from string

Задает нижнее ограничение (в формате даты и времени ISO 8601) для поиска в свойстве custom24, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom24 (верхний предел)
 custom24_to string

Задает верхний предел (в формате даты и времени ISO 8601) для поиска в свойстве custom24, связанном с рабочей областью. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom25
 custom25 boolean

Указывает значение, соответствующее пользовательскому значению25, связанному с рабочей областью.
Custom26
 custom26 boolean

Указывает значение, соответствующее пользовательскому значению26, связанному с рабочей областью.
Custom27
 custom27 boolean

Указывает значение, соответствующее пользовательскому значению27, связанному с рабочей областью.
Custom28
 custom28 boolean

Указывает значение, соответствующее пользовательскому значению28, связанному с рабочей областью.
Custom29
 custom29 string

Указывает значение, соответствующее пользовательскому значению29, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom30
 custom30 string

Указывает значение, соответствующее пользовательскому значению30, связанному с рабочей областью. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".

Получение библиотек

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

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

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

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

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

Указывает имя библиотеки.
Имя
 data.display_name string

Указывает отображаемое имя библиотеки.
Тип
 data.type string

Указывает тип библиотеки. Возможные значения: "worksite" или "linksite".
Скрыт
 data.is_hidden boolean

Указывает, скрыта ли библиотека.

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

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

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

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".

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

Имя Путь Тип Описание
Профили документов
 data array of MinimalDocumentProfileInArray

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

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

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

Параметры

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

Указывает идентификатор библиотеки целевого класса.
Идентификатор класса
 alias string

Указывает идентификатор класса или классов для поиска. Может быть разделенным запятыми списком. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию.
Description
 description string

Указывает текст, соответствующий в поле описания. Этот поиск не учитывает регистр. Поддерживается подстановочный знак (*). Частичные совпадения не поддерживаются.
Эхо
 echo boolean

Указывает, могут ли документы этого класса эхо-документы.
HIPAA
 hipaa boolean

Указывает, используются ли документы этого класса с шифрованием, совместимым с HIPAA.
Сменные
 indexable boolean

Указывает, индексируются ли документы этого класса полнотекстовой индексатором системы.
Query
 query string

Задает текст, соответствующий полям идентификатора или описания. Этот поиск не учитывает регистр. Поддерживаются подстановочные знаки (*) и частичные совпадения.
Обязательный подкласс
 subclass_required boolean

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

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

Имя Путь Тип Описание
Идентификатор класса Top Matching
 data.topMatchingId string

Указывает идентификатор верхнего соответствующего класса. Например, "ПЕТИЦИЯ".
Описание класса top Matching
 data.topMatchingDescription string

Указывает описание верхнего соответствующего класса.
results
 data.results array of object

Указывает список классов, доступных в библиотеке, которая соответствует указанным критериям.
Description
 data.results.description string

Указывает дополнительные сведения о классе.
Is HIPAA
 data.results.hipaa boolean

Указывает, зашифрован ли документ.
Идентификатор
 data.results.id string

Указывает идентификатор класса. Например, "ПЕТИЦИЯ".
Индексируется
 data.results.indexable boolean

Указывает, индексируется ли документ системой.
Безопасность по умолчанию
 data.results.default_security string

Указывает уровень доступа по умолчанию. Возможные значения: public, view, private.
Retain
 data.results.retain integer

Указывает количество дней перед маркировкой неактивных документов этого класса по истечении срока действия.
Обязательные поля
 data.results.required_fields array of string

Указывает обязательные настраиваемые свойства, которые необходимо ввести при создании или обновлении документа этого класса.
Тень
 data.results.shadow boolean

Указывает, что документ этого класса теневой (сохраняется) на локальном компьютере пользователя после его проверки.
Обязательный подкласс
 data.results.subclass_required boolean

Указывает, является ли подкласс обязательным для этого класса.

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

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

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

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Последнее
 latest boolean

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

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

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

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

Параметры

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

Указывает идентификатор библиотеки целевого подкласса.
Идентификатор класса
 classId True string

Указывает идентификатор класса, который является родительским элементом этого подкласса. Например, "ПЕТИЦИЯ".
Идентификатор подкласса
 alias string

Указывает идентификатор подклассов для поиска. Может быть разделенным запятыми списком. Поддерживается подстановочный знак (*). Частичные совпадения поддерживаются при использовании подстановочного знака.
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию.
Description
 description string

Указывает текст, соответствующий в поле описания. Поддерживается подстановочный знак (*). Частичные совпадения поддерживаются при использовании подстановочного знака.
Эхо
 echo boolean

Указывает, можно ли отклонять подклассы на локальный жесткий диск пользователя. Это позволяет упростить работу в автономном режиме.
HIPAA
 hipaa boolean

Указывает, следует ли возвращать подклассы, совместимые с HIPAA.
Query
 query string

Задает текст, соответствующий полям идентификатора или описания подкласса. Поддерживается подстановочный знак (*). Поддерживаются частичные совпадения.

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

Имя Путь Тип Описание
Идентификатор подкласса верхнего уровня
 data.topMatchingId string

Указывает идентификатор подкласса верхнего соответствия.
Описание подкласса top Matching
 data.topMatchingDescription string

Указывает описание подкласса верхнего соответствия.
results
 data.results array of object
Безопасность по умолчанию
 data.results.default_security string

Указывает уровень доступа по умолчанию. Возможные значения: public, view, private.
Description
 data.results.description string

Указывает дополнительные сведения о подклассе. Максимальная длина: 255 символов.
Is HIPAA
 data.results.hipaa boolean

Указывает, зашифрован ли документ.
Идентификатор
 data.results.id string

Указывает идентификатор подкласса, используемого для создания или изменения сведений профиля документа. Например, GUARDIANSHIP.
Родительский идентификатор
 data.results.parent.id string

Указывает идентификатор родительского класса подкласса.
Обязательные поля
 data.results.required_fields array of string

Указывает обязательные настраиваемые свойства, которые необходимо ввести при создании или обновлении документа данного подкласса.
Retain
 data.results.retain integer

Указывает количество дней, прежде чем пометить неактивные документы этого подкласса по истечении срока действия.
Тень
 data.results.shadow boolean

Указывает, что документ этого подкласса затенен (сохраняется) на локальном компьютере пользователя после его проверки.

Получение попечителей

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Тип объекта
 objectType True string

Указывает тип объекта.
Код объекта
 objectId True string

Указывает идентификатор документа, папки или рабочей области. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".

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

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

Указывает список попечителей с определенными разрешениями для документа, папки или рабочей области. Доверенное лицо может быть пользователем или группой.
Полное имя
 data.full_name string

Указывает полное имя доверенного лица.
Идентификатор
 data.id string

Указывает идентификатор доверенного лица. Это может быть идентификатор группы или идентификатор пользователя. Например, JSMITH или MARKETING.
SSID
 data.ssid string

Указывает уникальный системный идентификатор доверенного лица.
Тип
 data.type string

Указывает тип возвращаемой сущности. Возможные значения : user или group.

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

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

Возвращает свойства документа, связанные с определенным идентификатором документа.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Получение последней версии
 latest boolean

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

Получение профиля рабочей области

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

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

Параметры

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

Указывает идентификатор рабочей области. Например, "ACTIVE_US!427".

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

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Тип объекта
 objectType True string

Указывает тип объекта.
Код объекта
 objectId True string

Указывает идентификатор документа, папки или рабочей области. Примером идентификатора документа является "ACTIVE_US!453.1". Примером папки или идентификатора рабочей области является "ACTIVE_US!123".

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

Имя Путь Тип Описание
Безопасность по умолчанию
 data.default_security string

Указывает безопасность объекта по умолчанию. Возможные значения: "наследование", "public", "view" или "private".
Наследуемая безопасность по умолчанию
 data.inherited_default_security string

Указывает на унаследованную безопасность папки по умолчанию, если для безопасности по умолчанию задано значение "наследовать". Возможные значения: "public", "view" или "private".
Разрешения доступа
 data.acl AccessPermissions

Указывает коллекцию разрешений доступа для одного или нескольких пользователей и (или) групп.
Все идентификаторы пользователей
 data.all_user_ids string

Указывает список всех идентификаторов пользователей, объединенных в виде строки и разделенных точкой с запятой.
Все идентификаторы групп
 data.all_group_ids string

Указывает список всех идентификаторов групп, объединенных в виде строки и разделенных точкой с запятой.

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

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

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

Параметры

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

Указывает идентификатор библиотеки целевого пользователя.
Идентификатор пользователя
 userId True string

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

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

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

Указывает сведения о пользователе.

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

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

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

Параметры

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

Указывает идентификатор библиотеки целевой группы.
Идентификатор группы
 groupId True string

Указывает идентификатор группы. Например, "МАРКЕТИНГ".
Состояние входа
 logon_status string

Задает фильтр для пользователей на основе текущего значения свойства "allow_logon" для каждого пользователя.
Лимит
 limit integer

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

Указывает, что возвращаются только пользователи, предпочитаемая библиотека которых соответствует предоставленному значению.
Местоположение
 location string

Указывает расположение, используемое для поиска пользователей в зависимости от географического расположения. Этот поиск не учитывает регистр. Подстановочный знак (*) не поддерживается.

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

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

Указывает список пользователей, принадлежащих указанной группе, и соответствует указанным критериям.

Получение шаблонов рабочей области

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

Возвращает список шаблонов, доступных в библиотеке. Шаблон рабочей области — это предопределенная рабочая область, структура которой копируется для новой рабочей области.

Параметры

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

Указывает идентификатор библиотеки целевой рабочей области.
Custom1
 custom1 string

Указывает значение, соответствующее пользовательскому значению1, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom2
 custom2 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom3
 custom3 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom4
 custom4 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom5
 custom5 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom6
 custom6 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom7
 custom7 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom8
 custom8 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom9
 custom9 string

Указывает значение, соответствующее пользовательскому значению, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom10
 custom10 string

Указывает значение, соответствующее пользовательскому значению10, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom11
 custom11 string

Указывает значение, соответствующее пользовательскому значению11, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom12
 custom12 string

Указывает значение, соответствующее пользовательскому значению12, связанному с шаблоном рабочей области. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom17
 custom17 double

Задает значение для custom17.
Custom18
 custom18 double

Задает значение для custom18.
Custom19
 custom19 double

Задает значение для custom19.
Custom20
 custom20 double

Указывает значение для custom20.
Custom21
 custom21 string

Указывает значение (в формате даты и времени ISO 8601) для поиска в custom21, связанном с шаблоном рабочей области. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom22
 custom22 string

Указывает значение (в формате даты и времени ISO 8601) для поиска в custom22, связанном с шаблоном рабочей области. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom23
 custom23 string

Указывает значение (в формате даты и времени ISO 8601) для поиска в custom23, связанном с шаблоном рабочей области. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom24
 custom24 string

Указывает значение (в формате даты и времени ISO 8601) для поиска в custom24, связанном с шаблоном рабочей области. Этот поиск не учитывает регистр. Для рабочих областей использование этого свойства настраивается для установки iManage Work.
Custom21 (нижнее ограничение)
 custom21_from string

Указывает нижний предел настраиваемого 21 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom21 (верхний предел)
 custom21_to string

Задает верхний предел настраиваемой версии 21 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom21 (относительный)
 custom21_relative string

Указывает диапазон дат для поиска относительно текущей даты. Этот параметр имеет формат [begin]:[end][единиц времени (d, m или y)]. Например, -15:1d указывает диапазон дат от 15 дней до текущей даты до одного дня после текущей даты (один день в будущем).
Custom22 (нижнее ограничение)
 custom22_from string

Указывает нижний предел настраиваемой версии 22 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom22 (верхний предел)
 custom22_to string

Задает верхний предел пользовательского22 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom22 (относительный)
 custom22_relative string

Указывает диапазон дат для поиска относительно текущей даты. Этот параметр имеет формат [begin]:[end][единиц времени (d, m или y)]. Например, -15:1d указывает диапазон дат от 15 дней до текущей даты до одного дня после текущей даты (один день в будущем).
Custom23 (нижнее ограничение)
 custom23_from string

Задает нижний предел пользовательского 23 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom23 (верхний предел)
 custom23_to string

Задает верхний предел пользовательского 23 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom23 (относительный)
 custom23_relative string

Указывает диапазон дат для поиска относительно текущей даты. Этот параметр имеет формат [begin]:[end][единиц времени (d, m или y)]. Например, -15:1d указывает диапазон дат от 15 дней до текущей даты до одного дня после текущей даты (один день в будущем).
Custom24 (нижнее ограничение)
 custom24_from string

Задает нижний предел пользовательского 24 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom24 (верхний предел)
 custom24_to string

Задает верхний предел пользовательского24 (в формате даты и времени ISO 8601) для поиска. Это свойство не зарезервировано iManage Work и не является проверенным значением. Он предназначен для настройки требований вашей компании.
Custom24 (относительный)
 custom24_relative string

Указывает диапазон дат для поиска относительно текущей даты. Этот параметр имеет формат [begin]:[end][единиц времени (d, m или y)]. Например, -15:1d указывает диапазон дат от 15 дней до текущей даты до одного дня после текущей даты (один день в будущем).
Custom25
 custom25 boolean

Задает настраиваемое значение для поиска.
Custom26
 custom26 boolean

Указывает настраиваемое значение для поиска.
Custom27
 custom27 boolean

Указывает настраиваемое значение для поиска.
Custom28
 custom28 boolean

Задает настраиваемое значение28 для поиска.
Custom29
 custom29 string

Указывает значение для сопоставления с custom29. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.
Custom30
 custom30 string

Указывает значение для сопоставления с custom30. Этот поиск не учитывает регистр. Подстановочный знак (*) и частичные совпадения не поддерживаются.

Скачивание документа

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

Загружает версию определенного документа на основе идентификатора документа. Если последнее значение имеет значение true, скачиваются последние версии этого документа. Скачивание является потоком и не сохраняется локально.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_USE!453.1".
Получение последней версии
 latest boolean

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

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

Указывает содержимое файла.

Содержимое файла
binary

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

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

Создает связь между указанными документами в библиотеке.

Параметры

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

Указывает идентификатор первичного документа, который необходимо связать. Например, "ACTIVE_US!453.1".
Идентификатор связанного документа
 relatedDocumentId True string

Указывает идентификатор связанного документа. Например, "ACTIVE_US!453.1".

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

response
object

Создание рабочей области

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

Создает новую рабочую область на основе выбранного шаблона. Шаблон рабочей области — это предопределенная рабочая область, структура которой копируется в новую рабочую область. Ограничения шаблона рабочей области автоматически применяются при создании новой рабочей области.

Параметры

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

Указывает идентификатор библиотеки целевой рабочей области.
Template
 templateId True string

Указывает шаблон рабочей области, используемый для создания рабочей области и его дочерних элементов.
Имя
 name True string

Указывает имя рабочей области.
Создание дочерних элементов
 createChildren True string

Указывает, чтобы создать все папки (необязательно и обязательно) или только необходимые папки.
Владелец рабочей области
 owner string

Указывает владельца рабочей области. Чтобы задать владельца рабочей области, необходимо быть администратором системы iManage Work.
Безопасность по умолчанию
 default_security string

Указывает уровень доступа по умолчанию. Если он не указан, используется уровень доступа по умолчанию выбранного шаблона.
Description
 description string

Указывает дополнительные сведения о рабочей области.
Custom1
 custom1 string

Указывает значение custom1 для связывания с созданной рабочей областью. Это значение переопределяет настраиваемое значение выбранной рабочей области шаблона при наличии. Если дочерние папки имеют настраиваемое значение1, настраиваемое значение этих дочерних папок не перезаписывается.
Custom2
 custom2 string

Указывает значение custom2 для связывания с созданной рабочей областью. Чтобы указать значение для custom2, необходимо также указать значение для custom1 в том же запросе, которое связано с их отношением "родитель-дочерний". Это значение переопределяет настраиваемое2 значение выбранной рабочей области шаблона, если оно присутствует. Если дочерние папки имеют настраиваемый набор значений, настраиваемое2 значение этих дочерних папок не перезаписывается.
Custom3
 custom3 string

Указывает значение custom3.
Custom4
 custom4 string

Указывает значение custom4.
Custom5
 custom5 string

Указывает значение custom5.
Custom6
 custom6 string

Задает значение custom6.
Custom7
 custom7 string

Указывает значение custom7.
Custom8
 custom8 string

Задает значение custom8.
Custom9
 custom9 string

Задает значение custom9.
Custom10
 custom10 string

Указывает значение custom10.
Custom11
 custom11 string

Указывает значение custom11.
Custom12
 custom12 string

Задает значение custom12.
Custom13
 custom13 string

Задает значение custom13.
Custom14
 custom14 string

Указывает значение custom14.
Custom15
 custom15 string

Задает значение custom15.
Custom16
 custom16 string

Указывает значение custom16.
Custom17
 custom17 double

Указывает значение custom17.
Custom18
 custom18 double

Задает значение custom18.
Custom19
 custom19 double

Указывает значение custom19.
Custom20
 custom20 double

Задает значение custom20.
Custom21
 custom21 string

Задает значение custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Задает значение custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Задает значение custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Задает значение custom24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Задает значение custom25.
Custom26
 custom26 boolean

Указывает значение custom26.
Custom27
 custom27 boolean

Задает значение custom27.
Custom28
 custom28 boolean

Указывает значение custom28.
Custom29
 custom29 string

Задает значение custom29.
Custom30
 custom30 string

Указывает значение custom30. Чтобы указать значение для custom30, необходимо также указать значение для custom29 в том же запросе, которое связано с их отношением "родительский-дочерний".
Внешний как обычный
 is_external_as_normal boolean

Указывает, что рабочая область может рассматриваться как общедоступная рабочая область. Если задано значение true, а "default_security" не является "закрытым", задайте для значения "is_external" значение true.
Project Custom1
 project_custom1 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Project Custom2
 project_custom2 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Project Custom3
 project_custom3 string

Указывает дополнительные сведения о рабочей области. Это поле отличается от настраиваемого поля метаданных, связанного с элементами содержимого, такими как документы, рабочие области или папки. Это описательный текст, который не должен быть отформатирован, и не проверяется.
Подкласс рабочей области
 subclass string

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

Удаление документа

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

Удаляет указанный документ.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Удаление всех версий
 deleteAllVersions True boolean

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

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

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

Удаляет связь между указанными документами в библиотеке.

Параметры

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

Указывает идентификатор первичного документа. Например, "ACTIVE_US!453.1".
Идентификатор связанного документа
 relatedDocumentId True string

Указывает идентификатор связанного документа. Например, "ACTIVE_US!453.1".

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

response
object

Удаление ссылки на документ

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

Удаляет ссылку на документ из указанной папки.

Параметры

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

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Идентификатор папки
 folderId True string

Указывает идентификатор папки. Например, "ACTIVE_US!773".

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

response
object

Триггеры

Для выбранного документа

Этот триггер позволяет запустить рабочий процесс для выбранного документа в библиотеке iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.
Для выбранной рабочей области

Этот триггер позволяет запустить рабочий процесс для выбранной рабочей области в библиотеке iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.
Для нескольких выбранных документов

Этот триггер позволяет запустить рабочий процесс для одного или нескольких выбранных документов в iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.
Для нескольких выбранных рабочих областей

Этот триггер позволяет запустить рабочий процесс для одной или нескольких выбранных рабочих областей в iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.

Для выбранного документа

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

Этот триггер позволяет запустить рабочий процесс для выбранного документа в библиотеке iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Отображаемое имя рабочего процесса
 workflowName True string

Указывает отображаемое имя рабочего процесса, который будет отображаться пользователям iManage Work.
Description
 description True string

Указывает описание рабочего процесса.
Идентификатор библиотеки
 libraryId True string

Указывает идентификатор библиотеки, в которой доступен рабочий процесс.
Идентификатор формы
 formId True string

Указывает идентификатор формы, представленной пользователю для сбора входных данных, используемых рабочим процессом.
Возвращаемый идентификатор папки
 inferFolderId True boolean

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

Указывает один или несколько идентификаторов пользователей, разделенных точкой с запятой, для которых доступен рабочий процесс.
Доступно для групп
 groups string

Указывает один или несколько идентификаторов групп, разделенных точкой с запятой, для которой доступен рабочий процесс.
Доступно в рабочих областях
 workspaces string

Задает один или несколько идентификаторов рабочих областей, разделенных точкой с запятой, в которой доступен рабочий процесс.
Классы документов
 classes string

Задает один или несколько идентификаторов классов документов, разделенных точкой с запятой, для которой доступен рабочий процесс.
Ожидание завершения
 waitForCompletion boolean

Указывает, ожидают ли приложения, пока рабочий процесс не завершит выполнение. Если задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса".

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

Выходные данные этой операции являются динамическими.

Для выбранной рабочей области

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

Этот триггер позволяет запустить рабочий процесс для выбранной рабочей области в библиотеке iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Отображаемое имя рабочего процесса
 workflowName True string

Указывает отображаемое имя рабочего процесса, который будет отображаться пользователям iManage Work.
Description
 description True string

Указывает описание рабочего процесса.
Идентификатор библиотеки
 libraryId True string

Указывает идентификатор библиотеки, в которой доступен рабочий процесс.
Идентификатор формы
 formId True string

Указывает идентификатор формы, представленной пользователю для сбора входных данных, используемых рабочим процессом.
Доступно пользователям
 users string

Указывает один или несколько идентификаторов пользователей, разделенных точкой с запятой, для которых доступен рабочий процесс.
Доступно для групп
 groups string

Указывает один или несколько идентификаторов групп, разделенных точкой с запятой, для которой доступен рабочий процесс.
Ожидание завершения
 waitForCompletion boolean

Указывает, ожидают ли приложения, пока рабочий процесс не завершит выполнение. Если задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса".

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

Выходные данные этой операции являются динамическими.

Для нескольких выбранных документов

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

Этот триггер позволяет запустить рабочий процесс для одного или нескольких выбранных документов в iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Отображаемое имя рабочего процесса
 workflowName True string

Указывает отображаемое имя рабочего процесса, который будет отображаться пользователям iManage Work.
Description
 description True string

Указывает описание рабочего процесса.
Идентификатор библиотеки
 libraryId True string

Указывает идентификатор библиотеки, в которой доступен рабочий процесс.
Идентификатор формы
 formId True string

Указывает идентификатор формы, представленной пользователю для сбора входных данных, используемых рабочим процессом.
Возвращаемый идентификатор папки
 inferFolderId True boolean

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

Указывает один или несколько идентификаторов пользователей, разделенных точкой с запятой, для которых доступен рабочий процесс.
Доступно для групп
 groups string

Указывает один или несколько идентификаторов групп, разделенных точкой с запятой, для которой доступен рабочий процесс.
Показать форму для каждого документа
 showFormPerObject boolean

Указывает, представлена ли форма отдельно для каждого выбранного объекта или только один раз для всех выбранных объектов.
Ожидание завершения
 waitForCompletion boolean

Указывает, ожидают ли приложения, пока рабочий процесс не завершит выполнение. Если задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса".

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

Выходные данные этой операции являются динамическими.

Для нескольких выбранных рабочих областей

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

Этот триггер позволяет запустить рабочий процесс для одной или нескольких выбранных рабочих областей в iManage Work. Укажите отображаемое имя, которое будет отображаться пользователям в приложениях iManage Work. Если для параметра "Ожидание завершения" задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса" в рабочем процессе, в противном случае приложения в конечном итоге будут истекать без указания состояния завершения пользователю.

Параметры

Имя Ключ Обязательно Тип Описание
Отображаемое имя рабочего процесса
 workflowName True string

Указывает отображаемое имя рабочего процесса, который будет отображаться пользователям iManage Work.
Description
 description True string

Указывает описание рабочего процесса.
Идентификатор библиотеки
 libraryId True string

Указывает идентификатор библиотеки, в которой доступен рабочий процесс.
Идентификатор формы
 formId True string

Указывает идентификатор формы, представленной пользователю для сбора входных данных, используемых рабочим процессом.
Доступно пользователям
 users string

Указывает один или несколько идентификаторов пользователей, разделенных точкой с запятой, для которых доступен рабочий процесс.
Доступно для групп
 groups string

Указывает один или несколько идентификаторов групп, разделенных точкой с запятой, для которой доступен рабочий процесс.
Ожидание завершения
 waitForCompletion boolean

Указывает, ожидают ли приложения, пока рабочий процесс не завершит выполнение. Если задано значение "Да", необходимо использовать действие "Обновить состояние рабочего процесса".

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

Выходные данные этой операции являются динамическими.

Определения

MinDocumentProfileInArray

Указывает профиль каждой версии документа.

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

Указывает идентификатор пользователя, создавшего документ. Например, JSMITH.
Описание автора
 author_description string

Указывает дополнительные сведения о авторе документа.
Основные свойства документа
 basic_properties string

Указывает внедренный элемент "", содержащий базовые свойства документа.
Класс документа
 class string

Указывает класс документа.
Комментарий
 comment string

Указывает дополнительные сведения о документе.
Тип контента
 content_type string

Указывает тип контента документа.
Дата создания документа
 create_date string

Указывает дату и время (в формате ISO 8601) документ был импортирован в систему iManage Work. Эта дата может отличаться от "file_create_date".
Custom1
 custom1 string

Указывает значение custom1.
Пользовательское описание
 custom1_description string

Указывает дополнительные сведения о свойстве custom1.
Custom2
 custom2 string

Указывает значение custom2.
Описание Custom2
 custom2_description string

Указывает дополнительные сведения о свойстве custom2.
Custom3
 custom3 string

Указывает значение custom3.
Описание Custom3
 custom3_description string

Указывает дополнительные сведения о свойстве custom3.
Custom4
 custom4 string

Указывает значение custom4.
Пользовательское описание
 custom4_description string

Указывает дополнительные сведения о свойстве custom4.
Custom5
 custom5 string

Указывает значение custom5.
Описание Custom5
 custom5_description string

Указывает дополнительные сведения о свойстве custom5.
Custom6
 custom6 string

Указывает значение custom6.
Пользовательское описание
 custom6_description string

Указывает дополнительные сведения о свойстве custom6.
Custom7
 custom7 string

Указывает значение custom7.
Описание Custom7
 custom7_description string

Указывает дополнительные сведения о свойстве custom7.
Custom8
 custom8 string

Указывает значение custom8.
Описание Custom8
 custom8_description string

Указывает дополнительные сведения о свойстве custom8.
Custom9
 custom9 string

Указывает значение custom9.
Описание Custom9
 custom9_description string

Указывает дополнительные сведения о свойстве custom9.
Custom10
 custom10 string

Указывает значение custom10.
Описание Custom10
 custom10_description string

Указывает дополнительные сведения о свойстве custom10.
Custom11
 custom11 string

Указывает значение custom11.
Описание Custom11
 custom11_description string

Указывает дополнительные сведения о свойстве custom11.
Custom12
 custom12 string

Указывает значение custom12.
Описание Custom12
 custom12_description string

Указывает дополнительные сведения о свойстве custom12.
Custom13
 custom13 string

Указывает значение custom13.
Custom14
 custom14 string

Указывает значение custom14.
Custom15
 custom15 string

Указывает значение custom15.
Custom16
 custom16 string

Указывает значение custom16.
Custom17
 custom17 double

Указывает значение custom17.
Custom18
 custom18 double

Указывает значение custom18.
Custom19
 custom19 double

Указывает значение custom19.
Custom20
 custom20 double

Указывает значение custom20.
Custom21
 custom21 string

Указывает значение свойства custom21 в формате даты и времени ISO 8601.
Custom22
 custom22 string

Указывает значение свойства custom22 в формате даты и времени ISO 8601.
Custom23
 custom23 string

Указывает значение свойства custom23 в формате даты и времени ISO 8601.
Custom24
 custom24 string

Указывает значение свойства custom24 в формате даты и времени ISO 8601.
Custom25
 custom25 boolean

Указывает значение custom25.
Custom26
 custom26 boolean

Указывает значение custom26.
Custom27
 custom27 boolean

Указывает значение custom27.
Custom28
 custom28 boolean

Указывает значение custom28.
Custom29
 custom29 string

Указывает значение custom29.
Описание Custom29
 custom29_description string

Указывает дополнительные сведения о свойстве custom29.
Custom30
 custom30 string

Указывает значение custom30.
Описание Custom30
 custom30_description string

Указывает дополнительные сведения о свойстве custom30.
База данных
 database string

Указывает библиотеку, в которой хранится документ.
Безопасность документа по умолчанию
 default_security string

Указывает уровень доступа по умолчанию. Возможные значения: "наследование", "private", "view", "public".
Номер документа
 document_number integer

Указывает номер документа.
URL-адрес документа
 document_url string

Указывает ссылку, доступную для общего доступа для документа.
Дата редактирования документа
 edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения документа.
Дата изменения профиля
 edit_profile_date string

Указывает дату и время (в формате ISO 8601) последнего изменения профиля документа.
Расширение документа
 extension string

Указывает расширение имени файла, которое также называется расширением приложения.
Полное имя файла
 full_file_name string

Указывает полное имя файла документа. Включает расширение имени файла.
Идентификатор документа
 id string

Указывает идентификатор документа. Например, "ACTIVE_US!453.1".
Индексируется
 indexable boolean

Указывает, индексируется ли документ системой.
Извлечено
 is_checked_out boolean

Указывает, извлекается ли документ.
Объявлен
 is_declared boolean

Указывает, объявлен ли документ как запись. Документ, объявленный как запись, не может быть изменен или удален, за исключением системного администратора iManage Work.
Внешний
 is_external boolean

Указывает, предоставлен ли документ внешним пользователям.
Is HIPAA
 is_hipaa boolean

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

Указывает, используется ли документ.
Ссылка на документ
 iwl string

Указывает ссылку на iManage Work Link (iWL) для документа. IWL используется для открытия документа в режиме защищенного представления пользователем, у которого есть "read_write" или "full_access".
Последний пользователь
 last_user string

Указывает идентификатор пользователя, который редактировал документ в последнее время. Например, JSMITH.
Последнее описание пользователя
 last_user_description string

Указывает дополнительные сведения о последнем пользователе, который редактировал документ в последнее время.
Имя документа
 name string

Указывает имя файла документа.
Operator
 operator string

Указывает идентификатор пользователя, который извлечен документ или в настоящее время редактирует свой профиль. Например, JSMITH.
Описание оператора
 operator_description string

Указывает дополнительные сведения о операторе.
Связан
 is_related boolean

Указывает, связан ли документ с другим документом.
Размер документа
 size integer

Указывает размер документа в байтах.
Тип
 type string

Указывает тип документа. Например, WORD для Microsoft Word. Для текущего списка типов обратитесь к системному администратору iManage Work.
Версия документа
 version integer

Указывает номер версии документа.
Wstype
 wstype string

Указывает тип объекта iManage Work. Возможные значения: "document", "folder", "workspace", "email", "document_shortcut", "folder_shortcut", "workspace_shortcut", "user".

Профиль пользователя

Указывает сведения о пользователе.

Имя Путь Тип Описание
Разрешить вход
 allow_logon boolean

Указывает, разрешен ли пользователю входить в систему.
Custom1
 custom1 string

Указывает дополнительные сведения о пользователе.
Custom2
 custom2 string

Указывает дополнительные сведения о пользователе.
Custom3
 custom3 string

Указывает дополнительные сведения о пользователе.
Код каталога
 directory_id string

Указывает идентификатор внешнего каталога (например, ADFS), который используется для синхронизации профилей пользователей.
Различающееся имя
 distinguished_name string

Указывает имя объекта, представляющего полный путь к именам, которые трассирует запись обратно в корень дерева LDAP.
Дата редактирования
 edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения профиля пользователя.
Адрес электронной почты
 email string

Указывает идентификатор электронной почты пользователя.
URL-адрес автоматического обнаружения Exchange
 exch_autodiscover string

Указывает сведения о сервере Exchange пользователя.
Extension
 extension string

Указывает расширение номера телефона пользователя.
Неудачные попытки входа
 failed_logins integer

Указывает текущее количество неудачных попыток входа пользователя.
Факс
 fax string

Указывает номер факса пользователя.
Принудительное изменение пароля
 force_password_change boolean

Указывает, что пользователь должен изменить пароль при следующем входе. Применимо только к виртуальным пользователям, указанным значением "user_nos" "2".
Полное имя
 full_name string

Указывает полное имя пользователя.
General
 general string

Указывает общие сведения о пользователе.
Идентификатор пользователя
 id string

Указывает идентификатор пользователя. Например, JSMITH.
Внешний пользователь
 is_external boolean

Указывает внешнего пользователя. Внешний пользователь имеет ограниченный доступ и обычно используется для временных членов группы, консультантов или внешних для организации.
Время последней синхронизации
 last_sync_ts string

Указывает время последней синхронизации (в формате даты и времени ISO 8601) профиля пользователя с внешним каталогом, например LDAP или Microsoft Active Directory (ADFS).
Местоположение
 location string

Указывает географическое расположение пользователя.
Срок действия пароля никогда не истекает
 password_never_expire boolean

Указывает, не истекает ли срок действия пароля пользователя.
Номер телефона
 phone string

Указывает номер телефона пользователя.
Предпочтительная библиотека
 preferred_library string

Указывает предпочтительную библиотеку. Предпочтительная библиотека — это библиотека по умолчанию пользователя. У каждого пользователя должна быть одна предпочтительная библиотека.
Время изменения пароля
 pwd_changed_ts string

Указывает время (в формате даты и времени ISO 8601) при последнем изменении пароля пользователя. Это применимо только к виртуальным пользователям (чей пользователь NOS равен 2).
SSID
 ssid string

Указывает уникальный системный идентификатор пользователя.
Домен пользователя
 user_domain string

Указывает полное доменное имя для службы каталогов пользователя.
Расширенный идентификатор пользователя
 user_id_ex string

Указывает исходное значение идентификатора пользователя, полученного из внешнего каталога, например Microsoft Active Directory (ADFS).
Пользователь NOS
 user_nos integer

Указывает тип операционной системы, из которой синхронизируется пользователь. Возможные значения: 2 (виртуальный пользователь) и 6 (корпоративный пользователь). Для получения дополнительной информации обратитесь к системному администратору iManage Work.
Номер пользователя
 user_num integer

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

UserProfileInArray

Имя Путь Тип Описание
Разрешить вход
 allow_logon boolean

Указывает, разрешен ли пользователю входить в систему.
Custom1
 custom1 string

Указывает дополнительные сведения о пользователе.
Custom2
 custom2 string

Указывает дополнительные сведения о пользователе.
Custom3
 custom3 string

Указывает дополнительные сведения о пользователе.
Код каталога
 directory_id string

Указывает идентификатор внешнего каталога (например, ADFS), который используется для синхронизации профилей пользователей.
Различающееся имя
 distinguished_name string

Указывает имя объекта, представляющего полный путь к именам, которые трассирует запись обратно в корень дерева LDAP.
Дата редактирования
 edit_date string

Указывает дату и время (в формате ISO 8601) последнего изменения профиля пользователя.
Адрес электронной почты
 email string

Указывает идентификатор электронной почты пользователя.
URL-адрес автоматического обнаружения Exchange
 exch_autodiscover string

Указывает сведения о сервере Exchange пользователя.
Extension
 extension string

Указывает расширение номера телефона пользователя.
Неудачные попытки входа
 failed_logins integer

Указывает текущее количество неудачных попыток входа пользователя.
Факс
 fax string

Указывает номер факса пользователя.
Принудительное изменение пароля
 force_password_change boolean

Указывает, что пользователь должен изменить пароль при следующем входе. Применимо только к виртуальным пользователям, указанным значением "user_nos" "2".
Полное имя
 full_name string

Указывает полное имя пользователя.
General
 general string

Указывает общие сведения о пользователе.
Идентификатор
 id string

Указывает идентификатор пользователя. Например, JSMITH.
Внешний пользователь
 is_external boolean

Указывает внешнего пользователя. Внешний пользователь имеет ограниченный доступ и обычно используется для временных членов группы, консультантов или внешних для организации.
Время последней синхронизации
 last_sync_ts string

Указывает время последней синхронизации (в формате даты и времени ISO 8601) профиля пользователя с внешним каталогом, например LDAP или Microsoft Active Directory (ADFS).
Местоположение
 location string

Указывает географическое расположение пользователя.
Срок действия пароля никогда не истекает
 password_never_expire boolean

Указывает, не истекает ли срок действия пароля пользователя.
Номер телефона
 phone string

Указывает номер телефона пользователя.
Предпочтительная библиотека
 preferred_library string

Указывает предпочтительную библиотеку. Предпочтительная библиотека — это библиотека по умолчанию пользователя. У каждого пользователя должна быть одна предпочтительная библиотека.
Время изменения пароля
 pwd_changed_ts string

Указывает время (в формате даты и времени ISO 8601) при последнем изменении пароля пользователя. Это применимо только к виртуальным пользователям (чей пользователь NOS равен 2).
SSID
 ssid string

Указывает уникальный системный идентификатор пользователя.
Домен
 user_domain string

Указывает полное доменное имя для службы каталогов пользователя.
Расширенный идентификатор пользователя
 user_id_ex string

Указывает исходное значение идентификатора пользователя, полученного из внешнего каталога, например Microsoft Active Directory (ADFS).
NOS
 user_nos integer

Указывает тип операционной системы, из которой синхронизируется пользователь. Возможные значения: 2 (виртуальный пользователь) и 6 (корпоративный пользователь). Для получения дополнительной информации обратитесь к системному администратору iManage Work.
Number
 user_num integer

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

TaxonomyNodeValue

Указывает каждое значение таксономии узла.

Имя Путь Тип Описание
SSID
 created_by.ssid string

Указывает уникальный системный идентификатор пользователя, создавшего значение узла.
Дата создания
 create_date date-time

Указывает дату и время (в формате ISO 8601) созданное значение узла.
Description
 description string

Указывает описание значения узла.
SSID
 edited_by.ssid string

Указывает уникальный идентификатор, созданный системой, для пользователя, который последний раз редактировал значение узла.
Дата редактирования
 edit_date date-time

Указывает дату и время (в формате ISO 8601) последнее изменение значения узла.
Включен
 enabled boolean

Указывает, включено ли значение узла.
Идентификатор
 id string

Указывает идентификатор отображения значения узла.
SSID
 parent.ssid string

Указывает уникальный идентификатор, созданный системой для немедленного родительского узла.
SSID
 ssid string

Указывает уникальный идентификатор, созданный системой для значения узла.
Путь
 path array of object

Указывает полный путь к значению узла. Путь — это упорядоченный список, начинающийся с узла верхнего уровня в таксономии, а затем все узлы через ближайший родительский элемент соответствующего узла.
Каждый идентификатор
 path.id string

Указывает идентификатор отображения значения узла в пути.
Каждый SSID
 path.ssid string

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

UpdatePermissionsResponse

Имя Путь Тип Описание
Безопасность по умолчанию
 data.default_security string

Указывает безопасность объекта по умолчанию. Возможные значения: "наследование", "public", "view" или "private".
Разрешения доступа
 data.acl AccessPermissions

Указывает коллекцию разрешений доступа для одного или нескольких пользователей и (или) групп.
Все идентификаторы пользователей
 data.all_user_ids string

Указывает список всех идентификаторов пользователей, объединенных в виде строки и разделенных точкой с запятой.
Все идентификаторы групп
 data.all_group_ids string

Указывает список всех идентификаторов групп, объединенных в виде строки и разделенных точкой с запятой.

AccessPermissions

Указывает коллекцию разрешений доступа для одного или нескольких пользователей и (или) групп.

Имя Путь Тип Описание
Имя доверенного лица
 name string

Указывает имя доверенного лица.
Идентификатор доверенного лица
 id string

Указывает идентификатор доверенного лица. Это может быть идентификатор пользователя или идентификатор группы.
Sid доверенного лица
 sid string

Указывает идентификатор безопасности пользователя или группы.
Тип доверенного лица
 type string

Указывает тип возвращенного попечителя. Возможные значения : user или group.
Уровень доступа
 access_level string

Указывает разрешение на доступ, которое пользователь или группа имеют в объекте. Возможные значения: "no_access", "чтение", "read_write" или "full_access".
Отображаемое имя уровня доступа
 access_level_display_name string

Указывает отображаемое имя на уровне доступа, доступное для чтения, назначенное пользователю или группе для этого объекта. Возможные значения: "Нет доступа", "Только для чтения", "Чтение и запись" или "Полный доступ".
Доступ
 access integer

Указывает числовое значение разрешения доступа, которое пользователь или группа имеют в объекте. Возможные значения: 0 (no_access), 1 (чтение), 2 (read_write) или 3 (full_access).
Внешний
 is_external boolean

Указывает, является ли пользователь внешним пользователем или если группа ограничена внешними пользователями.
Разрешить вход
 allow_logon boolean

Указывает, разрешен ли пользователю входить в систему. Неприменимо к группам.
Включен
 enabled boolean

Указывает, включена ли группа. Неприменимо к пользователям.
Имеет ограниченный член
 has_restricted_member boolean

Указывает, имеет ли группа по крайней мере один пользователь с доступом к этому объекту, отказано в диспетчере политик безопасности iManage.

объект

Это тип object.

бинарный

Это базовый тип данных binary.