NetDocuments

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

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

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

Контакт
URL	https://support.netdocuments.com/hc/en-us

Метаданные соединителя
Publisher	NetDocuments Software, Inc.
Веб-сайт	https://www.netdocuments.com/
Политика конфиденциальности	https://www.netdocuments.com/privacy-policy/

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

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

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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
Регион	струна	Регион, в котором находится чистый документ.	True

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

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

Действия

Блокировка версии документа	Блокировка версии документа
Блокировка документа	Блокировка документа
Возврат документа	Возврат документа с выходом
Добавление или удаление группы из шкафа	Добавление группы в кабинет и права доступа по умолчанию
Добавление или удаление члена группы	Добавление или удаление члена группы
Добавление пользователя в репозиторий или удаление пользователя из репозитория	Добавление пользователя в репозиторий или удаление пользователя из репозитория
Журнал документов	Получение списка действий, выполняемых в документе
Обновление документа	Обновление содержимого документа
Обновление рабочей области	Обновление рабочей области
Ознакомьтесь с документом	Ознакомьтесь с документом
Переименование документа	Переименование документа
Переименование папки	Переименование папки
Поиск в кабинете и изменение списков управления доступом	Поиск в кабинете и изменение списков управления доступом
Поиск записей таблицы подстановки	Поиск записей таблицы подстановки
Поиск одного или нескольких шкафов	Поиск одного или нескольких шкафов
Получение версий документов	Получение версий документов
Получение групп репозитория	Получение групп репозитория
Получение групп шкафов	Получение всех групп, добавленных в кабинет
Получение дочерней записи таблицы подстановки	Получение дочерней записи таблицы подстановки
Получение журнала репозитория	Получение журнала репозитория
Получение записи таблицы подстановки или поиск дочерних записей таблицы	Получение записи таблицы подстановки или поиск дочерних записей таблицы
Получение или создание рабочей области (с одним атрибутом)	Получение или создание рабочей области (с одним атрибутом)
Получение или создание рабочей области (с родительскими и дочерними атрибутами)	Получение или создание рабочей области (с родительскими и дочерними атрибутами)
Получение настраиваемых атрибутов шкафа	Получение настраиваемых атрибутов шкафа
Получение параметров шкафа	Получение параметров шкафа
Получение пользователей репозитория	Получение пользователей репозитория
Получение прав доступа к группам кабинетов unhidden	Получение прав доступа к группам кабинетов unhidden
Получение профиля документа	Получение сведений о документе
Получение сведений о группе	Получение сведений о группе
Получение сведений о кабинете	Получение сведений о кабинете
Получение сведений о пользователе	Получение сведений о пользователе
Получение сведений о рабочей области	Получение сведений о рабочей области
Получение сведений о репозитории	Получение сведений о репозитории
Получение сведений о текущем пользователе	Получение сведений о текущем пользователе, идентификатор не требуется
Получение содержимого документа	Получение документа
Получение содержимого контейнера	Получение содержимого выбранного контейнера
Получение списка пользовательских шкафов	Получение пользовательских шкафов
Получение членства в группах	Получение членства в группах
Получение элементов папки	Получение содержимого папки, включая документы и вложенные папки
Разблокировка документа	Распаковка документа
Следуйте документу	Получение оповещений при обновлении документа
Следуйте папке	Получение оповещений при добавлении нового содержимого в папку
Создание CollabSpace	Создание нового CollabSpace
Создание внешней группы шкафа	Создание внешней группы шкафа
Создание группы репозитория	Создание группы репозитория
Создание документа	Создать новый документ
Создание защищенной ссылки	Создание ссылки на документ, к которому может получить доступ любой пользователь
Создание или обновление дочерней записи таблицы подстановки	Создание или обновление дочерней записи таблицы подстановки
Создание или обновление записи таблицы подстановки	Создание или обновление записи таблицы подстановки
Создание новой версии документа	Создание новой версии документа
Создание пользователя	Создание пользователя в репозитории
Создать папку	Создание папки
Удаление группы репозитория	Удаление группы репозитория
Удаление документа	Удаление документа
Удаление дочерней записи таблицы подстановки	Удаление дочерней записи таблицы подстановки
Удаление записи таблицы подстановки	Удаление записи таблицы подстановки
Удаление папки	Удаление папки
Файл или документ отмены файла в папку	Файл элемента в папке или отмене файла элемента из папки.

Блокировка версии документа

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

LockDocumentVersion

Блокировка версии документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Версия документа	version	True	integer	Версия документа
Описание версии	description		string	Описание версии

Блокировка документа

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

LockDocument

Блокировка документа

Параметры

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

Возврат документа

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

CheckinDoc

Возврат документа с выходом

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Расширение документа	extension		string	Не включайте ведущий период.
Содержимое документа	file		file	Документ в многокомпонентной форме.
Добавление в последние	addToRecent		boolean	Добавьте в список последних документов пользователя.

Добавление или удаление группы из шкафа

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

AddToOrRemoveGroupFromCabinet

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)
Добавление или удаление группы	action	True	string	Добавление или удаление группы
Идентификатор группы	id	True	string	Идентификатор группы (начинается с UG-).
Просмотр прав	view	True	boolean	Просмотр прав (V) — только для добавления.
Изменение прав	edit	True	boolean	Изменение прав (E) — только для добавления.
Предоставление общего доступа к правам	share	True	boolean	Предоставление общего доступа (S) — только для добавления.
Администрирование прав	administer	True	boolean	Администрирование прав (A) — только для добавления.
Нет прав доступа	noAccess	True	boolean	Нет прав доступа (N) — только для добавления.

Добавление или удаление члена группы

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

AddOrRemoveGroupMember

Добавление или удаление члена группы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupID	True	string	(Начинается с UG-)
Добавление или удаление пользователя	action	True	string	Добавление или удаление пользователя
Идентификатор пользователя	member	True	string	(Должен быть членом репозитория уже.)

Добавление пользователя в репозиторий или удаление пользователя из репозитория

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

AddOrRemoveUserRepository

Добавление пользователя в репозиторий или удаление пользователя из репозитория

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Добавление или удаление пользователя	action	True	string	Добавление или удаление пользователя
Идентификатор пользователя	member	True	string	Идентификатор пользователя
Пользователь является внешним	external	True	boolean	Пользователь является внешним
Удаление пользователя (если федеративное)	deleteIfFederated		boolean	(Применимо только при удалении)

Журнал документов

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

GetDocHistory

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

Параметры

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

Обновление документа

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

UpdateDocument

Обновление содержимого документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Расширение документа	extension		string	Необходимо только при изменении расширения документа. Не включайте ведущий период.
Кодировка Base64?	base64		boolean	Кодировка Base64?
Обновленное содержимое документа	body	True	byte	Содержимое документа.

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

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

RefreshWorkspace

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

Параметры

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

Ознакомьтесь с документом

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

CheckOutDoc

Ознакомьтесь с документом

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Комментарий	comment		string	Комментарий
Скачивание документа	download		boolean	Возвращает содержимое документа.
Версия для скачивания	version		string	Указывает, какая версия должна быть загружена. По умолчанию используется официальная версия.
Добавление в последние	addToRecent		boolean	Добавление в последние

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

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

RenameDocument

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Новое имя	name	True	string

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

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

RenameFolder

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

Параметры

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

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

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

SearchCabinetModifyACLs

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)
Query	q	True	string	(Ознакомьтесь с документацией по формату запроса)
Изменение режима ACL	mode	True	string	Изменение режима ACL
Новый список ACL	newAcl	True	string	(Ознакомьтесь с документацией по правильному формату json)
Адрес электронной почты	email		email	(Вместо этого отправьте уведомление на этот адрес)
Отправка сообщений электронной почты о завершении	completionEmail		string	(true = всегда отправлять (по умолчанию), false = не отправлять, сбой = отправка только при сбое)

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

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

SearchLookupEntries

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор атрибута	attributeID	True	string	(Удалите ведущий "10")
Filter	$filter		string	(См. документацию по доступным фильтрам)
Поля для получения	$select		string	(Включите разделенный запятыми список: "ключ", "description", "parent", "hold", "closed", "defaulting", "type", "user" и /или "access")
Количество соответствующих записей для пропуска	$skip		integer	(Это используется при получении нескольких блоков результатов.)
Максимальное количество возвращаемых записей	$top		integer	Максимальное количество возвращаемых записей

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

Имя	Путь	Тип	Описание
Строк	rows	array of object
Значение по умолчанию	rows.defaulting	string
описание	rows.description	string
держать	rows.hold	boolean
key	rows.key	string
закрытый	rows.closed	string
доступ	rows.access	string

Поиск одного или нескольких шкафов

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

SearchCabinets

Поиск одного или нескольких шкафов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Шкафы	cabinets	True	string	(разделители-запятые)
Query	q	True	string	(Ознакомьтесь с документацией по формату запроса)
Возвращаемые сведения	select	True	string	(Ознакомьтесь с документацией по формату возврата)
Заказ по	orderby		string	(Формат: field#|desc или field#|asc)
Количество возвращаемых результатов (по умолчанию — 50)	top		integer	(Не более 500 на страницу)
Количество пропустить результаты	skip		integer	Количество пропустить результаты
Маркер, используемый для разбиения результатов на страницы	skiptoken		string	Маркер, используемый для разбиения результатов на страницы

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

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

GetDocumentVersions

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	documentID	True	string	12-значный идентификатор документа.

Получение групп репозитория

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

GetRepositoryGroups

Получение групп репозитория

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Filter	$filter		string	(См. документацию по критериям фильтрации)
Количество результатов	$top		string	(По умолчанию — 5000. Максимум 10 000)
Paging	paging		boolean	(Возвращает результаты на страницах; значение по умолчанию — false)
Маркер разбиения по страницам	$skiptoken		string	(Для разбиения по страницам; возвращается предыдущими вызовами как next)
Возврат сведений	returnInfo		string	все будут возвращать имена групп. Значение по умолчанию пусто для возврата только идентификаторов

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

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

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

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

GetCabinetGroups

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)

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

Имя	Путь	Тип	Описание
		array of object
Идентификатор	Id	string
Имя	Name	string
External	External	boolean
Скрытый	Hidden	boolean

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

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

GetChildEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор дочернего атрибута	childAttributeID	True	string	(Удалите ведущий "10")
Родительский ключ	parentID	True	string	Родительский ключ
Дочерний ключ	childID	True	string	Дочерний ключ

Получение журнала репозитория

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

GetRepositoryLog

Получение журнала репозитория

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Дата и время начала	start		string	(По умолчанию используется значение 30 дней; формат гггг-ММ-дд или гггг-ММ-ddThh:mm:ssZ)
Дата и время окончания	end		string	(Тот же формат, что и начало; по умолчанию используется по умолчанию)
Тип журнала	Logtype	True	string	Тип журнала

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

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

GetLookupEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор атрибута	attributeID	True	string	(Удалите ведущий "10". Чтобы вернуть одно значение, введите идентификатор родительского атрибута или выполните поиск дочерних записей, введите идентификатор дочернего атрибута.)
Key	parentID	True	string	(Чтобы вернуть одно значение, введите ключ одного атрибута или выполните поиск дочерних записей, введите ключ родительского элемента.)
Фильтр (только при поиске)	$filter		string	(См. документацию по доступным фильтрам)
Поля для получения	$select		string	(Включите разделенный запятыми список: "ключ", "description", "parent", "hold", "closed", "defaulting", "type", "user" и /или "access")
Количество соответствующих записей для пропуска	$skip		integer	(Это используется при получении нескольких блоков результатов.)
Максимальное количество возвращаемых записей	$top		integer	Максимальное количество возвращаемых записей
Упорядочить результаты по	$orderby		string	Упорядочить результаты по

Получение или создание рабочей области (с одним атрибутом)

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

CreateWorkspaceSingle

Получение или создание рабочей области (с одним атрибутом)

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)
Единственное значение	parentID	True	string	Единственное значение, используемое для определения рабочих областей в кабинете.

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

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

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

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

CreateWorkspaceParentChild

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)
Родительское значение	parentID	True	string	Родительское значение, используемое для определения рабочих областей в кабинете.
Дочернее значение	childID	True	string	Дочернее значение, используемое для определения рабочих областей в кабинете.

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

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

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

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

GetCabinetCustomAttributes

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)

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

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

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

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

GetCabinetSettings

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)

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

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

GetRepositoryUsers

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)

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

Имя	Путь	Тип	Описание
		array of object
отображаемое имя	displayName	string
электронная почта	email	string
внешний	external	boolean
id	id	string
lastLogin	lastLogin	string
зарегистрированный	registered	string

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

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

GetCabinetDefaultAccess

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)

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

Имя	Путь	Тип	Описание
		array of object
управлять	administer	boolean
cabDefault	cabDefault	boolean
edit	edit	boolean
имя	name	string
noAccess	noAccess	boolean
основной	principal	string
общая папка	share	boolean
view	view	boolean

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

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

GetDocInfo

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

Параметры

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

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

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

GetGroupInformation

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupID	True	string	Идентификатор группы (начинается с UG-).
Членство в кабинете групп	cabMembership		boolean	(Если задано значение true, шкафы этой группы являются членами и права доступа к документам по умолчанию для каждого кабинета будут включены.)

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

Имя	Путь	Тип	Описание
внешний	external	boolean
hidden	hidden	boolean
hideMembership	hideMembership	boolean
id	id	string
имя	name	string
cabMembership	cabMembership	array of object
id	cabMembership.id	string
имя	cabMembership.name	string
права	cabMembership.rights	string

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

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

GetCabinetInformation

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)

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

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

GetUserInfo

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор пользователя	id	True	string	Идентификатор пользователя, назначенный NetDocuments.
Идентификатор шкафа	cabGuid		string	(Начинается с NG-)

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

Имя	Путь	Тип	Описание
отображаемое имя	displayName	string
электронная почта	email	email
id	id	string
организация	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
внешний	external	boolean

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

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

GetWorkspaceInformation

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

Параметры

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

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

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

GetRepositoryInformation

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)

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

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

GetCurrentUserInfo

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabGuid		string	(Начинается с NG-)

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

Имя	Путь	Тип	Описание
отображаемое имя	displayName	string
электронная почта	email	email
id	id	string
организация	organization	string
isRepositoryMember	isRepositoryMember	boolean
primaryCabinet	primaryCabinet	string
sortLookupBy	sortLookupBy	string
внешний	external	boolean

Получение содержимого документа

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

GetDocContent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Кодировка Base64?	base64		boolean	Кодировка Base64?

Получение содержимого контейнера

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

GetContainerContents

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор контейнера	containerID	True	string	Идентификатор контейнера
Возвращаемые сведения	select	True	string	(Ознакомьтесь с документацией по формату возврата)
Количество возвращаемых результатов (по умолчанию — 50)	top		integer	(Не более 500 на страницу)
Маркер, используемый для разбиения результатов на страницы	skiptoken		string	Маркер, используемый для разбиения результатов на страницы
Заказ по	orderby		string	(Формат: field#|desc или field#|asc)

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

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

GetUserCabinets

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

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

Имя	Путь	Тип	Описание
		array of object
id	id	string
isCollaborationSpacesEnabled	isCollaborationSpacesEnabled	string
имя	name	string
репозиторийId	repositoryId	string
имя репозитория	repositoryName	string
wsAttrNum	wsAttrNum	integer
wsOrgAttrNum	wsOrgAttrNum	integer

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

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

GetGroupMembership

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы	groupID	True	string	(Начинается с UG-)

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

Имя	Путь	Тип	Описание
		array of object
отображаемое имя	displayName	string
id	id	string

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

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

GetFldContent

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	id	True	string	12-значный идентификатор папки.
Атрибуты для возврата	$select		string	Разделенный запятыми список значений атрибутов. Дополнительные сведения см. в документации по REST API.

Разблокировка документа

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

UnockDocument

Распаковка документа

Параметры

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

Следуйте документу

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

FollowDocument

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Получатели	recipients	True	string	Один или несколько допустимых адресов электронной почты, разделенных точкой с запятой. Дубликаты игнорируются.
Отправить	send		string	Какая категория пользователей должна получать оповещение.

Следуйте папке

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

FollowFolder

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	id	True	string	12-значный идентификатор папки.
Получатели	recipients	True	string	Один или несколько допустимых адресов электронной почты, разделенных точкой с запятой. Дубликаты игнорируются.
Отправить	send		string	Какая категория пользователей должна получать оповещение.

Создание CollabSpace

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

CreateCollabSpace

Создание нового CollabSpace

Параметры

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

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

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

Создание внешней группы шкафа

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

CreateCabinetExternalGroup

Создание внешней группы шкафа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabinetID	True	string	(Начинается с NG-)
Имя группы	name	True	string	Имя группы
Параметры группы	options		string	Параметры группы
Доступ к кабинету по умолчанию	access		string	Доступ к кабинету по умолчанию
Идентификатор CollabSpace	collaborationSpaceId		string	(Чтобы сделать эту группу CollabSpace-external)
Доступ к CollabSpace	collaborationspaceaccess		string	Доступ к CollabSpace
Значение атрибута верхней рабочей области	topwsattributegroupkey		string	(Для обычных внешних групп кабинетов; связывание группы с определенным значением атрибута рабочей области)

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

Имя	Путь	Тип	Описание
Тип	Type	integer
Идентификатор	Id	string
Имя	Name	string
Options	Options	string
Доступ	Access	string

Создание группы репозитория

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

CreateRepositoryGroup

Создание группы репозитория

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Имя группы	name	True	string	Имя группы
External	external	True	boolean	External
Скрытие в списках	hidden	True	boolean	Скрытие в списках
Скрытое членство	hideMembership	True	boolean	Скрытое членство

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

Имя	Путь	Тип	Описание
внешний	external	boolean
hidden	hidden	boolean
hideMembership	hideMembership	boolean
id	id	string
имя	name	string

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

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

CreateDocument

Создать новый документ

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Место назначения	destination	True	string	12-значный идентификатор или EnvID папки, фильтра или рабочей области.
Содержимое документа	file	True	file	Поместите расширение "имя файла плюс" в соответствующее поле имени файла.
Добавление в последние	addToRecent		boolean	Добавление в последние
Профиль документа	profile		string	Задание профиля документа (формат JSON)

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

Имя	Путь	Тип	Описание
id	id	string
Расширение	extension	string
имя	name	string

Создание защищенной ссылки

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

CreateSecuredLink

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Пароль для защищенной ссылки	password		string	В зависимости от конфигурации шкафа пароль может быть необязательным или обязательным.
Дата окончания срока действия защищенной ссылки.	expirationdate		string	Формат ввода: гггг-ММ-дд.
Версия документа	version		string	Какая версия документа для общего доступа. Если она пуста, официальная версия будет общей.
Скачивание документа	download		boolean	Если значение true, документ может быть скачан получателем.
Уведомить меня	notifyme		boolean	Если задано значение true, уведомите отправителя о доступе к защищенной ссылке.
Блокировка документа	lock		boolean	При необходимости заблокируйте выбранную версию документа. Для этого требуются права редактирования.

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

Имя	Путь	Тип	Описание
view	standardAttributes.view	string
загрузить	standardAttributes.download	string

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

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

CreateChildEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор дочернего атрибута	childAttributeID	True	string	(Удалите ведущий "10")
Родительский ключ	parentID	True	string	Родительский ключ
Дочерний ключ	childID	True	string	Дочерний ключ
Description	description		string
Тип	defaulting		string
Хранение для судебного разбирательства	hold		boolean
Дата закрытия	closed		string	Формат '/Date(Number of Millis From 1 1, 1970+-UTC', like: '/Date(15822612000000-05000)/'
Отфильтрованные разрешения	filtered_permissions	True	boolean
Принудительное перемыкания	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Поделиться	share	True	boolean
Администрирование	administer	True	boolean
Нет доступа	noAccess	True	boolean
Кабинет по умолчанию	cabDefault	True	boolean
Директор	principal	True	string	(Идентификатор пользователя или группы)

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

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

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

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

CreateEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор атрибута	attributeID	True	string	(Удалите ведущий "10")
Key	parentID	True	string	Key
Description	description		string
Тип	defaulting		string
Хранение для судебного разбирательства	hold		boolean
Дата закрытия	closed		string	Формат '/Date(Number of Millis From 1 1, 1970+-UTC', like: '/Date(15822612000000-05000)/'
Отфильтрованные разрешения	filtered_permissions	True	boolean
Принудительное перемыкания	force_permissions	True	boolean
View	view	True	boolean
Edit	edit	True	boolean
Поделиться	share	True	boolean
Администрирование	administer	True	boolean
Нет доступа	noAccess	True	boolean
Кабинет по умолчанию	cabDefault	True	boolean
Директор	principal	True	string	(Идентификатор пользователя или группы)

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

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

Создание новой версии документа

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

NewVersion

Создание новой версии документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Расширение документа	extension		string	Не включайте ведущий период.
Описание версии	version_description		string	Описание версии
Имя новой версии	verName		string	Имя новой версии
Создание официальной версии	official		boolean	Новая версия не будет официальной, если этот параметр не задан.
Добавление в последние документы	addToRecent		boolean	Добавление в последние документы
Номер исходной версии	srcVer		string	При копировании содержимого из предыдущей версии, какая версия документа копируется.
Создание в качестве подверсии	allocatesubversion		boolean	Создайте подверсию вместо полной версии.
Новое содержимое документа версии	body		binary	Содержимое новой версии, если не копирует другую версию или официальную версию.

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

Имя	Путь	Тип	Описание
latestVersionNumber	latestVersionNumber	integer
newVer	newVer	integer
newVersionLabel	newVersionLabel	string
officialVer	officialVer	integer
officialVerName	officialVerName	string
versions	versions	integer

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

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

CreateUser

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя пользователя	username	True	email	(Совпадает с адресом электронной почты пользователя)
Имя (первое имя)	displayFirstName	True	string	Имя (первое имя)
Отчество/второе имя	displayMiddleName		string	Отчество/второе имя
Фамилия	displayLastName	True	string	Фамилия
Адрес электронной почты	email	True	email	Адрес электронной почты
Пользователь является внешним	external	True	boolean	(Применимо только при добавлении)
Отправьте приветственное сообщение электронной почты	sendWelcome	True	boolean	Отправьте приветственное сообщение электронной почты
Идентификатор репозитория	repository	True	string	(Начинается с ЦС-)

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

Имя	Путь	Тип	Описание
отображаемое имя	displayName	string
электронная почта	email	email
id	id	string
внешний	external	boolean

Создать папку

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

CreateFolder

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя папки	name	True	string	Имя папки.
Родительский идентификатор	parent		string	12-значный идентификатор или EnvID родительского контейнера новой папки.
Идентификатор шкафа	cabinet		string	(Начинается с NG-) Может быть опущен, если в родительском элементе указан идентификатор папки или рабочей области.

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

Имя	Путь	Тип	Описание
id	standardAttributes.id	string
имя	standardAttributes.name	string

Удаление группы репозитория

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

DeleteRepositoryGroup

Удаление группы репозитория

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор группы	groupID	True	string	(Начинается с UG-)

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

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

DeleteDoc

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	12-значный идентификатор документа.
Удаление безвозвратно	permanent		boolean	Указывает, что документ должен быть окончательно удален, а не перемещен в удаленные элементы.

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

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

DeleteChildEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор дочернего атрибута	childAttributeID	True	string	(Удалите ведущий "10")
Родительский ключ	parentID	True	string	Родительский ключ
Дочерний ключ	childID	True	string	Дочерний ключ

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

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

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

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

DeleteLookupEntry

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор репозитория	repositoryID	True	string	(Начинается с ЦС-)
Идентификатор атрибута	attributeID	True	string	(Удалите ведущий "10")
Key	parentID	True	string	Key

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

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

Удаление папки

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

DeleteFolder

Удаление папки

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	id	True	string	12-значный идентификатор папки.
Удаление безвозвратно	permanent		boolean	Указывает, что папка должна быть окончательно удалена, а не перемещена в удаленные элементы. Содержимое папки, включая вложенные папки-потомки, не будет окончательно удалено.
Удаление содержимого папки	deleteContents		boolean	Указывает, что документы в удаленной папке (и в любой подпапке-потомке) должны быть также удалены, а не просто неподдерживаемые.

Файл или документ отмены файла в папку

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

FileFolder

Файл элемента в папке или отмене файла элемента из папки.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор папки	id	True	string	12-значный идентификатор папки.
Идентификатор документа	item	True	string	12-значный идентификатор документа.
Файл или отмена файла	action	True	string	Файл или отмена файла

Триггеры

Кабинет поиска

Поиск в указанном кабинете

Кабинет поиска

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

SearchCab

Поиск в указанном кабинете

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор шкафа	cabId	True	string	(Начинается с NG-)
Критерии поиска	q	True	string	Используйте тот же формат и операторы, что и в веб-интерфейсе NetDocuments.
Заказ по	$orderby		string	Заказ по
Максимальное количество результатов	$top		string	Целое число от 1 до 500. Значение по умолчанию — 100.
Атрибуты для возврата	$select		string	Разделенный запятыми список значений атрибутов. Дополнительные сведения см. в документации по REST API.