GoFileRoom

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

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

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

Контакт
Имя	Поддержка GoFileRoom
URL	https://tax.thomsonreuters.com/us/en/cs-professional-suite/support/contact
Адрес электронной почты	CS.Support@ThomsonReuters.com

Метаданные соединителя
Publisher	Thomson Reuters.
Веб-сайт	https://www.gofileroom.com/
Политика конфиденциальности	https://www.thomsonreuters.com/en/privacy-statement.html
Категории	Данные; Управление бизнесом

Соединитель GoFileRoom позволяет клиентам Thomson Reuters использовать API для GoFileRoom и FirmFlow. Пользователи могут создавать автоматизацию и интеграцию, связанную с управлением пользователями, документами или FirmFlow.

Предпосылки

У пользователей должен быть ключ API GoFileRoom для использования соединителя.

Как получить учетные данные?

Ключ API можно получить, зарегистрируя учетную запись по https://developerportal.thomsonreuters.com/адресу. Кроме того, вам потребуется активная учетная запись GoFileRoom. Если вы заинтересованы в GoFileRoom, обратитесь к нам здесь: https://tax.thomsonreuters.com/us/en/cs-professional-suite/gofileroom#contact

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

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


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

По умолчанию

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

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

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

Имя	Тип	Description	Обязательно
X-TR-API-APP-ID	securestring	API X-TR-APP-ID для этого API	True

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

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

Действия

Вход	Записывает пользователя в приложение
Выход	Выход из приложения
Добавление главного доставить	Добавление главного доставить
Документ taxsort	Pdf-документ taxsort
Изменение WorkFlow	Изменение WorkFlow
Изменение главного доставить	Изменение главного доставить
Изменение группы	Изменение разрешений группы
Изменение пользователя	Изменение разрешений пользователя
Копирование документа	Копирует документы
Настройка безопасности групповых документов	Назначение безопасности документов группе
Настройка безопасности пользовательских документов	Назначение разрешений безопасности документов пользователем
Настройка разрешений группы	Назначает разрешение группе
Настройка разрешений пользователей	Назначает пользователю разрешение
Отслеживание отчета по доставке версии 2	Отслеживание отчета по DeliverableV2
Отслеживание отчета по рабочему процессу	Отслеживание отчета по рабочему процессу
Переиндекс документа	Повторное индексация документов
Поиск документов	Загружает все документы, к которые пользователь имеет доступ в указанном ящике.
Поиск подстановки индекса	Этот метод предназначен для использования с полями автозаполнения.
Получение безопасности групповых документов	Получение безопасности документов группы
Получение безопасности документов пользователя	Получение сведений о безопасности документов пользователя для входа
Получение главного доставить	Получение главного доставить
Получение групп	Извлекает группы, доступные для управления пользователями и группами
Получение данных FirmFlow по доставке	Возвращает отчет отслеживания по конечным данным
Получение динамических правил для индекса	Возвращает список динамических правил, настроенных для указанного индекса.
Получение документа	Скачивает документ
Получение дочерних индексов	Возвращает список дочерних значений индекса на основе идентификатора списка, который предоставляется при выборе родительского значения списка.
Получение журнала документов	Возвращает журнал документа
Получение значений LookupList	Получение значений из LookupList
Получение индексов документов	Извлекает индексы документа
Получение индексов ящика	Извлекает список индексов документов, настроенных для ящика
Получение лицензий	Извлекает количество лицензий
Получение политики паролей	Получение политики паролей для фирмы
Получение пользователей	Извлекает пользователей GFR для пользователя, вошедшего в систему
Получение разрешений группы	Получает разрешения групп
Получение разрешений пользователей	Получает разрешения пользователя
Получение расположений отправки	Получение расположений отправки для пользователя
Получение сведений о пользователе	Получение сведений о пользователях GFR
Получение сведений о пользователе версии 2	Возвращает интромацию пользователя
Получение состояния документа	Получение состояния документов
Получение списка значений индекса	Возвращает все записи для индекса типа списка
Получение списка отчетов	Получение отчетов, доступных для управления пользователями
Получение ящиков	Извлекает ящики, доступные для пользователя, вошедшего в систему
Проверка индексов	Проверяет, допустимы ли указанные индексы.
Проверка маркера	Проверка состояния токена
Публикация состояния документа	Публикация или отмена публикации документов из ClientFlow.
Рабочий процесс маршрутизации версии 2	Рабочий процесс маршрутизации версии 2
Слияние PDF-файлов	Объединение PDF-файлов вместе
Создание документа	Создает запись документа с индексами
Создание пользователей	Создает пользователей GoFileRoom и ClientFlow в системе
Создание рабочего процесса	Создание рабочего процесса
Создать группу	Создание группы разрешений
Удаление главного доставить	Удаление главного доставить
Удаление документа	Удаляет документ
Удаление пользователя	Удаление пользователей GoFileRoom и ClientFlow из системы
Удаление рабочих процессов	Удаление рабочих процессов

Вход

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

Записывает пользователя в приложение

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя пользователя для входа	LoginName	True	string	Введите имя входа
Пароль	Password	True	password	Ввод пароля

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

Имя	Путь	Тип	Описание
authSuccess	authSuccess	boolean	успешно выполнена проверка подлинности
authenticationResponse	authenticationResponse	string	Значение ответа проверки подлинности
customerId	customerId	string	Значение идентификатора клиента
Код ошибки	errorCode	string	Значение кода ошибки
idleSessionTimeoutMinutes	idleSessionTimeoutMinutes	integer	Время ожидания сеанса простоя
loneStarFirmId	loneStarFirmId	string	Lone Star Firm Id
LoneStarValidated	loneStarValidated	boolean	Проверено лонирование звезды
token	token	string	Значение токена
userId	userId	string	Значение идентификатора пользователя
userName	userName	string	Значение имени пользователя

Выход

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

Выход из приложения

Параметры

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

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

Имя	Путь	Тип	Описание
isLogoutSuccess	isLogoutSuccess	boolean	Был успешной выход

Добавление главного доставить

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

Добавление главного доставить

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Имя доставки	deliverableName	string	Имя доставки
Срок	dueDate	string	Срок
Первое расширение	firstExtension	string	Первое расширение
Второе расширение	secondExtension	string	Второе расширение
Третье расширение	thirdExtension	string	Третье расширение
Календарь или финансовый	calenderOrFiscal	string	Календарь или финансовый
Extension	extension	integer	Extension
Тип службы	ServiceType	string	Тип службы
Имя ящика	DrawerName	string	Имя ящика

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

Имя	Путь	Тип	Описание
Сохраняется	isSaved	boolean	Сохраняется
Ответное сообщение	responseMessage	string	Ответное сообщение

Документ taxsort

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

Pdf-документ taxsort

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
body	body		array of string

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

Имя	Путь	Тип	Описание
		array of object
documentId	documentId	string	Значение идентификатора документа
isTaxSorted	isTaxSorted	boolean	Документ TaxSorted
taxsortDocumentException	taxsortDocumentException	string	Исключение документа taxsort

Изменение WorkFlow

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

Изменение WorkFlow

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Идентификатор подачи	filingId	integer	Идентификатор подачи
Имя клиента	ClientName	string	Имя клиента
Номер клиента	ClientNumber	string	Номер клиента
Тип взаимодействия	EngagementType	string	Тип взаимодействия
РИС	PIC	string	РИС
Год	Year	string	Год
Окончание периода	PeriodEnd	string	Окончание периода
Имя доставки	action	string	Имя доставки
Текущая дата выполнения	currentduedate	string	Текущая дата выполнения
Исходная дата выполнения	originalduedate	string	Исходная дата выполнения
Вложение	form	string	Вложение
Действие заметки	action	string	Действие заметки
Тип заметки	noteType	string	Тип заметки
noteid	noteid	array of string	noteid
Сообщение о заметках	note	string	Сообщение о заметках
Имя поля сведений	name	string	Имя поля сведений
Значение поля сведений	value	string	Значение поля сведений
Метод доставки	Delivery	string	Метод доставки
Место назначения	Destination	string	Место назначения
Исходный документ	sourceDocument	string	Исходный документ
Ответственное поле	responsibleField	string	Ответственное поле
Assigned To	value	string	Assigned To
Документация по переиндексу	reindexDocs	boolean	Документация по переиндексу

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

Имя	Путь	Тип	Описание
Идентификатор подачи	filingId	integer	Идентификатор подачи
Комментарий об ошибке	errorComment	string	Комментарий об ошибке
Состояние	status	boolean	Состояние
errorMessage	errorMessage	array of object	errorMessage
Имя	errorMessage.name	string	Имя
Состояние	errorMessage.status	boolean	Состояние
Комментарий об ошибке	errorMessage.errorComment	string	Комментарий об ошибке

Изменение главного доставить

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

Изменение главного доставить

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Текущее имя доставки	currentdeliverableName	string	Текущее имя доставки
Обновление имени доставки	updatedeliverableName	string	Обновление имени доставки
Срок	dueDate	string	Срок
Первое расширение	firstExtension	string	Первое расширение
Второе расширение	secondExtension	string	Второе расширение
Третье расширение	thirdExtension	string	Третье расширение
Календарь или финансовый	calenderOrFiscal	string	Календарь или финансовый
Extension	extension	integer	Extension
Тип службы	serviceType	string	Тип службы
Имя ящика	drawerName	string	Имя ящика

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

Имя	Путь	Тип	Описание
Статус обновления	isUpdated	boolean	Статус обновления
Ответное сообщение	responseMessage	string	Ответное сообщение

Изменение группы

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

Изменение разрешений группы

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	Указание true или false
AllowAccessToReports	AllowAccessToReports	string	Указание true или false
Comments	Comments	string	Ввод примечаний
EnableMfa	EnableMfa	string	Указание true или false
EnforceMfaForUsers	EnforceMfaForUsers	string	Указание true или false
FirmFlowRoutingNotification	FirmFlowRoutingNotification	string	Указание true или false
FullAccessToDocTracking	FullAccessToDocTracking	string	Указание true или false
GroupName	GroupName	string	Введите имя группы
MfaRequired	MfaRequired	string	Указание true или false
PermissonToApproveDocs	PermissonToApproveDocs	string	Указание true или false
Переименовать группу	RenameGroup	string	Введите имя новой группы
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	Указание true или false
IsDenyAll	IsDenyAll	string	Указание true или false
ReportType	ReportType	string	Указание true или false
UploadLocation	UploadLocation	string	Введите расположение отправки
Users	Users	array of string	Users

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

Имя	Путь	Тип	Описание
groupId	groupId	string	Значение идентификатора группы
isModified	isModified	boolean	Было ли в группе изменено
mfaException	mfaException	string	Исключение mfa
modifyGroupException	modifyGroupException	string	Изменение исключения группы

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

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

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

Параметры

Имя	Ключ	Тип	Описание
ТипПользователя	userType	string	Ввод типа пользователя
Токен	X-Authorization	string	Проверка подлинности маркера
AccountExpiresDate	AccountExpiresDate	string	Дата истечения срока действия учетной записи
DisabledComments	DisabledComments	string	Ввод примечаний
FullName	FullName	string	Введите полное имя
Groups	Groups	array of string	Groups
IsAccountExpires	IsAccountExpires	string	Указание true или false
IsAdvanceFlow	IsAdvanceFlow	string	Указание true или false
IsAllowAccessToReports	IsAllowAccessToReports	string	Указание true или false
IsAllowOffline	IsAllowOffline	string	Указание true или false
IsChangeNextLogin	IsChangeNextLogin	string	Указание true или false
Отключено	IsDisabled	string	Указание true или false
IsFirmFlow	IsFirmFlow	string	Указание true или false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	Указание true или false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	Указание true или false
IsMfa	IsMfa	string	Указание true или false
IsUserAdministration	IsUserAdministration	string	Указание true или false
IsWorkflowManagerUser	IsWorkflowManagerUser	string	Указание true или false
LicenseType	LicenseType	string	Ввод типа лицензии
Имя пользователя для входа	LoginName	string	Введите имя входа
ManagerEmail	ManagerEmail	string	Ввод электронной почты диспетчера
Пароль	Password	string	Ввод пароля
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	Указание true или false
IsDenyAll	IsDenyAll	string	Указание true или false
ReportType	ReportType	string	Указание true или false
UploadLocation	UploadLocation	string	Введите расположение отправки

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

Имя	Путь	Тип	Описание
isModified	isModified	boolean	Было изменено пользователем
mfaException	mfaException	string	Исключение mfa
modifyUserException	modifyUserException	string	Изменение исключения пользователя
userId	userId	string	Значение идентификатора пользователя

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

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
DocumentIds	DocumentIds	array of string	DocumentIds
IndexId	IndexId	string	Ввод идентификатора индекса
IndexValue	IndexValue	string	Введите значение индекса

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

Имя	Путь	Тип	Описание
		array of object
copyDocumentException	copyDocumentException	string	Копирование исключения документов
documentId	documentId	string	Значение идентификатора документа
isCopied	isCopied	boolean	Копируемый документ
newDocumentId	newDocumentId	string	новый идентификатор документа

Настройка безопасности групповых документов

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Имя кабинета	CabinetName	string	Введите имя кабинета
DocSecurityType	DocSecurityType	string	Ввод типа безопасности документов
IndexName	IndexName	string	Введите имя индекса
Операция	Operation	string	Введите тип операции
Ценности	Values	array of string	Ценности
Имя ящика	DrawerName	string	Введите имя ящика
GroupName	GroupName	string	Введите имя группы

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

Имя	Путь	Тип	Описание
groupName	groupName	string	Значение имени группы
isSetGroupDocSecurity	isSetGroupDocSecurity	boolean	Получение набора "Безопасность документов"
setGroupDocSecurityException	setGroupDocSecurityException	string	Исключение безопасности групповых документов

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

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Имя кабинета	CabinetName	string	Введите имя шкафа
DocSecurityType	DocSecurityType	string	Ввод типа безопасности документов
IndexName	IndexName	string	Введите имя индекса
Операция	Operation	string	Ввод операции
Ценности	Values	array of string	Ценности
Имя ящика	DrawerName	string	Введите имя ящика
LoginId	LoginId	string	Введите идентификатор входа

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

Имя	Путь	Тип	Описание
isSetUserDocSecurity	isSetUserDocSecurity	boolean	Применена ли защита документов пользователей
loginId	loginId	string	Значение идентификатора входа
setUserDocSecurityException	setUserDocSecurityException	string	Настройка исключения безопасности документации пользователя

Настройка разрешений группы

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

Назначает разрешение группе

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Шкаф	Cabinet	string	Введите имя шкафа
Добавить	Add	string	Указание true или false
Delete	Delete	string	Указание true или false
Deny	Deny	string	Указание true или false
Edit	Edit	string	Указание true или false
LookUp	LookUp	string	Указание true или false
Читайте	Read	string	Указание true или false
Ящик	Drawer	string	Введите имя ящика
Добавить	Add	string	Указание true или false
Delete	Delete	string	Указание true или false
Deny	Deny	string	Указание true или false
Edit	Edit	string	Указание true или false
LookUp	LookUp	string	Указание true или false
Читайте	Read	string	Указание true или false
GroupName	GroupName	string	Введите имя группы

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

Имя	Путь	Тип	Описание
groupId	groupId	string	Значение идентификатора группы
groupPermissionException	groupPermissionException	string	Исключение разрешений группы
isSet	isSet	boolean	Применены ли разрешения

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

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

Назначает пользователю разрешение

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Шкаф	Cabinet	string	Введите имя шкафа
Добавить	Add	string	Указание true или false
Delete	Delete	string	Указание true или false
Deny	Deny	string	Указание true или false
Edit	Edit	string	Указание true или false
LookUp	LookUp	string	Указание true или false
Читайте	Read	string	Указание true или false
Ящик	Drawer	string	Введите имя ящика
Добавить	Add	string	Указание true или false
Delete	Delete	string	Указание true или false
Deny	Deny	string	Указание true или false
Edit	Edit	string	Указание true или false
LookUp	LookUp	string	Указание true или false
Читайте	Read	string	Указание true или false
LoginId	LoginId	string	Введите идентификатор входа

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

Имя	Путь	Тип	Описание
isSetUserPermission	isSetUserPermission	boolean	Обновление разрешений пользователя
loginId	loginId	string	Значение идентификатора входа
setUserPermissionException	setUserPermissionException	string	Настройка исключения разрешений пользователя

Отслеживание отчета по доставке версии 2

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

Отслеживание отчета по DeliverableV2

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Идентификатор ящика	DrawerId	string	Идентификатор ящика
Тип службы	ServiceType	string	Тип службы
Тип взаимодействия	EngagementType	string	Тип взаимодействия
Рабочий процесс	Workflow	string	Рабочий процесс
Текущий шаг	CurrentStep	string	Текущий шаг
РИС	PIC	string	РИС
Assigned To	AssignedTo	string	Assigned To
Назначено	AssignedOn	string	Назначено
Описание рабочего процесса	WorkflowDescription	string	Описание рабочего процесса
Только в процессе	InProcessOnly	string	Только в процессе
Состояние	Status	string	Состояние
Priority	Priority	string	Priority
Получено	ReceivedOn	string	Получено
Завершено	CompletedOn	string	Завершено
Отправлено	SentOn	string	Отправлено
Ответственный	Responsible	string	Ответственный
Журнал назначений	AssignmentHistory	string	Журнал назначений
Получено от	ReceivedFrom	string	Получено от
Отправлено в	SentTo	string	Отправлено в
Завершено	CompletedBy	string	Завершено
Ответственный	Accountable	string	Ответственный
Текущая дата выполнения	CurrentDueDate	string	Текущая дата выполнения
Исходная дата выполнения	OriginalDueDate	string	Исходная дата выполнения
Расширенная дата	DateExtended	string	Расширенная дата
Дни на шаге	DaysAtStep	string	Дни на шаге
Всего дней на шаге	TotalDaysAtStep	string	Всего дней на шаге
Дни между маршрутизацией	DaysBetweenRoutings	string	Дни между маршрутизацией
Общее количество дней процесса	TotalDaysInProcess	string	Общее количество дней процесса
Сведения о маршрутизации	RoutingDetails	string	Сведения о маршрутизации
Последнее обновление	LastUpdated	string	Последнее обновление
InformationFields	InformationFields	array of string	InformationFields
Indexes	Indexes	array of string	Indexes
Номер страницы	PageNumber	string	Номер страницы

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

Имя	Путь	Тип	Описание
Всего записей	totalRecords	integer	Всего записей
Номер страницы	pageNumber	string	Номер страницы
Размер страницы	pageSize	integer	Размер страницы
Всего страниц	totalPages	integer	Всего страниц
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
Имя клиента	firmFlowReportResponse.clientName	string	Имя клиента
Номер клиента	firmFlowReportResponse.clientNumber	string	Номер клиента
Идентификатор ящика	firmFlowReportResponse.drawerId	string	Идентификатор ящика
Тип службы	firmFlowReportResponse.serviceType	string	Тип службы
Тип взаимодействия	firmFlowReportResponse.engagementType	string	Тип взаимодействия
Рабочий процесс	firmFlowReportResponse.workflow	string	Рабочий процесс
Текущий шаг	firmFlowReportResponse.currentStep	string	Текущий шаг
РИС	firmFlowReportResponse.pic	string	РИС
Assigned To	firmFlowReportResponse.assignedTo	string	Assigned To
Назначено	firmFlowReportResponse.assignedOn	string	Назначено
Год	firmFlowReportResponse.year	string	Год
Окончание периода	firmFlowReportResponse.periodEnd	string	Окончание периода
Описание рабочего процесса	firmFlowReportResponse.workflowDescription	string	Описание рабочего процесса
Progress	firmFlowReportResponse.progress	string	Progress
Состояние	firmFlowReportResponse.status	string	Состояние
Priority	firmFlowReportResponse.priority	string	Priority
eFile Да или нет	firmFlowReportResponse.eFileYesOrNo	string	eFile Да или нет
Расширенные да или нет	firmFlowReportResponse.extendedYesOrNo	string	Расширенные да или нет
Получено	firmFlowReportResponse.receivedOn	string	Получено
Завершено	firmFlowReportResponse.completedOn	string	Завершено
Отправлено	firmFlowReportResponse.sentOn	string	Отправлено
Результаты	firmFlowReportResponse.deliverables	string	Результаты
Ответственный	firmFlowReportResponse.responsible	string	Ответственный
Журнал назначений	firmFlowReportResponse.assignmentHistory	string	Журнал назначений
Получено от	firmFlowReportResponse.receivedFrom	string	Получено от
Отправлено в	firmFlowReportResponse.sentTo	string	Отправлено в
Завершено	firmFlowReportResponse.completedBy	string	Завершено
Ответственный	firmFlowReportResponse.accountable	string	Ответственный
Текущая дата выполнения	firmFlowReportResponse.currentDueDate	string	Текущая дата выполнения
Исходная дата выполнения	firmFlowReportResponse.originalDueDate	string	Исходная дата выполнения
Заметки о маршрутизации	firmFlowReportResponse.routingNotes	string	Заметки о маршрутизации
PIC Да или нет	firmFlowReportResponse.picYesOrNo	string	PIC Да или нет
Назначено да или нет	firmFlowReportResponse.assignedToYesOrNo	string	Назначено да или нет
Расширенная дата	firmFlowReportResponse.dateExtended	string	Расширенная дата
Дни на шаге	firmFlowReportResponse.daysAtStep	string	Дни на шаге
Всего дней на шаге	firmFlowReportResponse.totalDaysAtStep	string	Всего дней на шаге
Дни между маршрутизацией	firmFlowReportResponse.daysBetweenRoutings	string	Дни между маршрутизацией
Общее количество дней процесса	firmFlowReportResponse.totalDaysInProcess	string	Общее количество дней процесса
Идентификатор папки	firmFlowReportResponse.folderID	string	Идентификатор папки
Идентификатор подачи	firmFlowReportResponse.filingID	string	Идентификатор подачи
Идентификатор предварительной подачи	firmFlowReportResponse.priorFilingID	string	Идентификатор предварительной подачи
Последнее обновление	firmFlowReportResponse.lastUpdated	string	Последнее обновление
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
имя	firmFlowReportResponse.informationFields.name	string	имя
value	firmFlowReportResponse.informationFields.value	string	value
маршрутизацияSummary	firmFlowReportResponse.routingSummary	array of	маршрутизацияSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
Получение исключения FirmFlow	getFirmFlowException	string	Получение исключения FirmFlow

Отслеживание отчета по рабочему процессу

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

Отслеживание отчета по рабочему процессу

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Идентификатор ящика	DrawerId	string	Идентификатор ящика
Тип службы	ServiceType	string	Тип службы
Тип взаимодействия	EngagementType	string	Тип взаимодействия
Рабочий процесс	Workflow	string	Рабочий процесс
Текущий шаг	CurrentStep	string	Текущий шаг
РИС	PIC	string	РИС
Assigned To	AssignedTo	string	Assigned To
Назначено	AssignedOn	string	Назначено
Описание рабочего процесса	WorkflowDescription	string	Описание рабочего процесса
Только в процессе	InProcessOnly	string	Только в процессе
Состояние	Status	string	Состояние
Priority	Priority	string	Priority
Ответственный	Responsible	string	Ответственный
Журнал назначений	AssignmentHistory	string	Журнал назначений
Получено от	ReceivedFrom	string	Получено от
Получено	ReceivedOn	string	Получено
Отправлено в	SentTo	string	Отправлено в
Отправлено	SentOn	string	Отправлено
Завершено	CompletedBy	string	Завершено
Завершено	CompletedOn	string	Завершено
Текущая дата выполнения	CurrentDueDate	string	Текущая дата выполнения
Дни на шаге	DaysAtStep	string	Дни на шаге
Всего дней на шаге	TotalDaysAtStep	string	Всего дней на шаге
Дни между маршрутизацией	DaysBetweenRoutings	string	Дни между маршрутизацией
Общее количество дней процесса	TotalDaysInProcess	string	Общее количество дней процесса
Ответственный	Accountable	string	Ответственный
Сведения о маршрутизации	RoutingDetails	string	Сведения о маршрутизации
Последнее обновление	LastUpdated	string	Последнее обновление
InformationFields	InformationFields	array of string	InformationFields
Indexes	Indexes	array of string	Indexes
Номер страницы	PageNumber	string	Номер страницы

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

Имя	Путь	Тип	Описание
Всего записей	totalRecords	integer	Всего записей
Номер страницы	pageNumber	string	Номер страницы
Размер страницы	pageSize	integer	Размер страницы
Всего страниц	totalPages	integer	Всего страниц
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
Имя клиента	firmFlowReportResponse.clientName	string	Имя клиента
Номер клиента	firmFlowReportResponse.clientNumber	string	Номер клиента
Идентификатор ящика	firmFlowReportResponse.drawerId	string	Идентификатор ящика
Тип службы	firmFlowReportResponse.serviceType	string	Тип службы
Тип взаимодействия	firmFlowReportResponse.engagementType	string	Тип взаимодействия
Рабочий процесс	firmFlowReportResponse.workflow	string	Рабочий процесс
Текущий шаг	firmFlowReportResponse.currentStep	string	Текущий шаг
РИС	firmFlowReportResponse.pic	string	РИС
Assigned To	firmFlowReportResponse.assignedTo	string	Assigned To
Назначено	firmFlowReportResponse.assignedOn	string	Назначено
Год	firmFlowReportResponse.year	string	Год
Окончание периода	firmFlowReportResponse.periodEnd	string	Окончание периода
Описание рабочего процесса	firmFlowReportResponse.workflowDescription	string	Описание рабочего процесса
Progress	firmFlowReportResponse.progress	string	Progress
Состояние	firmFlowReportResponse.status	string	Состояние
Priority	firmFlowReportResponse.priority	string	Priority
eFile Да или нет	firmFlowReportResponse.eFileYesOrNo	string	eFile Да или нет
Расширенные да или нет	firmFlowReportResponse.extendedYesOrNo	string	Расширенные да или нет
Получено	firmFlowReportResponse.receivedOn	string	Получено
Завершено	firmFlowReportResponse.completedOn	string	Завершено
Отправлено	firmFlowReportResponse.sentOn	string	Отправлено
Результаты	firmFlowReportResponse.deliverables	string	Результаты
Ответственный	firmFlowReportResponse.responsible	string	Ответственный
Журнал назначений	firmFlowReportResponse.assignmentHistory	string	Журнал назначений
Получено от	firmFlowReportResponse.receivedFrom	string	Получено от
Отправлено в	firmFlowReportResponse.sentTo	string	Отправлено в
Завершено	firmFlowReportResponse.completedBy	string	Завершено
Ответственный	firmFlowReportResponse.accountable	string	Ответственный
Текущая дата выполнения	firmFlowReportResponse.currentDueDate	string	Текущая дата выполнения
Исходная дата выполнения	firmFlowReportResponse.originalDueDate	string	Исходная дата выполнения
Заметки о маршрутизации	firmFlowReportResponse.routingNotes	string	Заметки о маршрутизации
PIC Да или нет	firmFlowReportResponse.picYesOrNo	string	PIC Да или нет
Назначено да или нет	firmFlowReportResponse.assignedToYesOrNo	string	Назначено да или нет
Расширенная дата	firmFlowReportResponse.dateExtended	string	Расширенная дата
Дни на шаге	firmFlowReportResponse.daysAtStep	string	Дни на шаге
Всего дней на шаге	firmFlowReportResponse.totalDaysAtStep	string	Всего дней на шаге
Дни между маршрутизацией	firmFlowReportResponse.daysBetweenRoutings	string	Дни между маршрутизацией
Общее количество дней процесса	firmFlowReportResponse.totalDaysInProcess	string	Общее количество дней процесса
Идентификатор папки	firmFlowReportResponse.folderID	string	Идентификатор папки
Идентификатор подачи	firmFlowReportResponse.filingID	string	Идентификатор подачи
Последнее обновление рабочего процесса	firmFlowReportResponse.workflowLastUpdated	string	Последнее обновление рабочего процесса
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
имя	firmFlowReportResponse.informationFields.name	string	имя
value	firmFlowReportResponse.informationFields.value	string	value
маршрутизацияSummary	firmFlowReportResponse.routingSummary	array of	маршрутизацияSummary
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
Получение исключения FirmFlow	getFirmFlowException	string	Получение исключения FirmFlow

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

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
DocumentIds	DocumentIds	array of string	DocumentIds
IndexId	IndexId	string	Ввод идентификатора индекса
IndexValue	IndexValue	string	Введите значение индекса

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

Имя	Путь	Тип	Описание
		array of object
documentId	documentId	string	Значение идентификатора документа
isReIndexed	isReIndexed	boolean	— это документ ReIndexed
reIndexDocumentException	reIndexDocumentException	string	Исключение документа reIndex

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

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
DrawerId	DrawerId	string	Ввод идентификатора ящика
IndexId	IndexId	string	Ввод идентификатора индекса
IndexValue	IndexValue	string	Введите значение индекса
NumberOfRows	NumberOfRows	integer	Введите число строк
PageNumber	PageNumber	integer	Ввод номера страницы
SortField	SortField	string	Введите поле сортировки
SortOrder	SortOrder	string	Ввод порядка сортировки

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

Имя	Путь	Тип	Описание
documentIds	documentIds	array of string	documentIds
documentSearchCount	documentSearchCount	integer	Число поиска документов

Поиск подстановки индекса

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

Этот метод предназначен для использования с полями автозаполнения.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
IndexID	indexId	True	string	Введите идентификатор индекса
Токен	X-Authorization		string	Проверка подлинности маркера
ТипДействия	ActionType		integer	Ввод типа действия
Численность	Count		integer	Ввод числа
IndexValue	IndexValue		string	Введите значение индекса
ТипПоиска	SearchType		integer	Ввод типа поиска

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

Имя	Путь	Тип	Описание
		array of object
indexId	index.indexId	string	Значение идентификатора индекса
indexValue	index.indexValue	string	Значение индекса
linkedIndexes	linkedIndexes	array of object	linkedIndexes
indexId	linkedIndexes.indexId	string	indexId
indexValue	linkedIndexes.indexValue	string	indexValue

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GroupName	groupName	True	string	Введите имя группы
Имя кабинета	cabinetName	True	string	Введите имя шкафа
Имя ящика	drawerName	True	string	Введите имя ящика
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
Имя группы	groupName	string	Имя группы
Имя шкафа	cabinetName	string	Имя шкафа
Имя ящика	drawerName	string	Имя ящика
documentSecurity	documentSecurity	array of object	documentSecurity
Имя индекса	documentSecurity.indexName	string	Имя индекса
Тип безопасности документа	documentSecurity.docSecurityType	string	Тип безопасности документа
values	documentSecurity.values	array of string	values
Исключение безопасности документов группы	getGroupDocSecurityException	string	Исключение безопасности документов группы

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
LoginId	loginId	True	string	Введите идентификатор входа
Имя кабинета	cabinetName	True	string	Введите имя шкафа
Имя ящика	drawerName	True	string	Введите имя ящика
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
cabName	cabinetName	string	Имя шкафа
documentSecurity	documentSecurity	string	Значение безопасности документа
имя ящика	drawerName	string	Значение имени ящика
getUserDocSecurityException	getUserDocSecurityException	string	Исключение безопасности пользовательских документов
loginId	loginId	string	Значение идентификатора входа

Получение главного доставить

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

Получение главного доставить

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Номер страницы	PageNumber	integer	Номер страницы
Размер страницы	pageSize	integer	Размер страницы
Тип службы	ServiceType	string	Тип службы
Имя ящика	DrawerName	string	Имя ящика

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

Имя	Путь	Тип	Описание
deliverableList	deliverableList	array of object	deliverableList
Имя доставки	deliverableList.deliverableName	string	Имя доставки
Тип расширения	deliverableList.extensionType	string	Тип расширения
Срок	deliverableList.dueDate	string	Срок
Первое расширение	deliverableList.firstExtension	string	Первое расширение
Второе расширение	deliverableList.secondExtension	string	Второе расширение
Третье расширение	deliverableList.thirdExtension	string	Третье расширение
Extension	deliverableList.extension	string	Extension
Действие	deliverableList.action	string	Действие
Идентификатор обязательства	deliverableList.obligationId	string	Идентификатор обязательства
Управляемый фирмой вариант	deliverableList.firmManagedOption	string	Управляемый фирмой вариант
Всего записей	totalRecords	string	Всего записей
Ответное сообщение	responseMessage	string	Ответное сообщение

Получение групп

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
		array of object
id	id	string	Значение идентификатора группы
Мид	mfa	integer	Значение mfa
mfaRequired	mfaRequired	integer	Обязательное значение mfa
имя	name	string	Значение имени группы

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

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

Возвращает отчет отслеживания по конечным данным

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Ответственный	Accountable	string	Введите значение учетной записи
AssignedOn	AssignedOn	string	Ввод назначенной даты
AssignedTo	AssignedTo	string	Ввод присвоенного значению
AssignmentHistory	AssignmentHistory	string	Ввод журнала назначений
CompletedBy	CompletedBy	string	Введите "Завершено по значению"
Дата выполнения	CompletedOn	string	Ввод завершенной даты
CurrentDueDate	CurrentDueDate	string	Введите текущую дату выполнения
CurrentStep	CurrentStep	string	Ввод текущего шага
DateExtended	DateExtended	string	Ввод расширенной даты
DaysAtStep	DaysAtStep	string	Ввод дней на шаге
DaysBetweenRoutings	DaysBetweenRoutings	string	Ввод дней между маршрутизациями
DrawerId	DrawerId	string	Ввод идентификатора ящика
EngagementType	EngagementType	string	Ввод типа "Взаимодействие"
InProcessOnly	InProcessOnly	string	Введите только значение "В процессе"
Indexes	Indexes	array of string	Indexes
InformationFields	InformationFields	array of string	InformationFields
OriginalDueDate	OriginalDueDate	string	Введите исходную дату выполнения
РИС	PIC	string	Введите PIC
PageNumber	PageNumber	string	Ввод номера страницы
Priority	Priority	string	Ввод приоритета
ReceivedFrom	ReceivedFrom	string	Ввод полученного значения
ПолученоНа	ReceivedOn	string	Ввод полученной даты
Ответственный	Responsible	string	Введите ответственное значение
МаршрутизацияDetails	RoutingDetails	string	Введите сведения о маршрутизации
Отправленный	SentOn	string	Ввод отправленной даты
SentTo	SentTo	string	Ввод отправленного значения
ServiceType	ServiceType	string	Ввод типа службы
Состояние	Status	string	Ввод состояния
TotalDaysAtStep	TotalDaysAtStep	string	Ввод общего числа дней на шаге
TotalDaysInProcess	TotalDaysInProcess	string	Ввод общего числа дней в процессе
Рабочий процесс	Workflow	string	Введите имя рабочего процесса
WorkflowDescription	WorkflowDescription	string	Ввод описания рабочего процесса

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

Имя	Путь	Тип	Описание
firmFlowReportResponse	firmFlowReportResponse	array of object	firmFlowReportResponse
ответственный	firmFlowReportResponse.accountable	string	значение учетной записи
assignedOn	firmFlowReportResponse.assignedOn	string	назначена дата
assignedTo	firmFlowReportResponse.assignedTo	string	присвоено значение
assignedToYesOrNo	firmFlowReportResponse.assignedToYesOrNo	string	Назначен рабочий процесс
assignmentHistory	firmFlowReportResponse.assignmentHistory	string	Значение журнала назначений
clientName	firmFlowReportResponse.clientName	string	Значение имени клиента
clientNumber	firmFlowReportResponse.clientNumber	string	Значение номера клиента
completedBy	firmFlowReportResponse.completedBy	string	Завершено по значению
completedOn	firmFlowReportResponse.completedOn	string	Дата завершена
currentDueDate	firmFlowReportResponse.currentDueDate	string	текущая дата выполнения
currentStep	firmFlowReportResponse.currentStep	string	текущее значение шага
dateExtended	firmFlowReportResponse.dateExtended	string	Дата расширенных
daysAtStep	firmFlowReportResponse.daysAtStep	string	Дни рабочего процесса на шаге
daysBetweenRoutings	firmFlowReportResponse.daysBetweenRoutings	string	рабочие дни между маршрутизацией
Конечные результаты	firmFlowReportResponse.deliverables	string	Значение доставки
drawerId	firmFlowReportResponse.drawerId	string	Значение идентификатора ящика
eFileYesOrNo	firmFlowReportResponse.eFileYesOrNo	string	— это доставить файл eFiled
engagementType	firmFlowReportResponse.engagementType	string	Значение типа engagement
extendedYesOrNo	firmFlowReportResponse.extendedYesOrNo	string	имеет расширенный доставить
informationFields	firmFlowReportResponse.informationFields	array of object	informationFields
имя	firmFlowReportResponse.informationFields.name	string	имя
value	firmFlowReportResponse.informationFields.value	string	value
originalDueDate	firmFlowReportResponse.originalDueDate	string	исходная дата выполнения
periodEnd	firmFlowReportResponse.periodEnd	string	Окончание рабочего процесса периода
Рис	firmFlowReportResponse.pic	string	изображение рабочего процесса
picYesOrNo	firmFlowReportResponse.picYesOrNo	string	назначено изображение
priority	firmFlowReportResponse.priority	string	значение приоритета
прогресс	firmFlowReportResponse.progress	string	Значение хода выполнения
receivedFrom	firmFlowReportResponse.receivedFrom	string	получено из значения
receivedOn	firmFlowReportResponse.receivedOn	string	получена дата
ответственный	firmFlowReportResponse.responsible	string	ответственное значение
responsibleUserOrGroups	firmFlowReportResponse.responsibleUserOrGroups	array of	responsibleUserOrGroups
routingNotes	firmFlowReportResponse.routingNotes	string	Заметки о маршрутизации рабочего процесса
маршрутизацияSummary	firmFlowReportResponse.routingSummary	array of	маршрутизацияSummary
sentOn	firmFlowReportResponse.sentOn	string	дата отправки
sentTo	firmFlowReportResponse.sentTo	string	отправлено в значение
тип услуги	firmFlowReportResponse.serviceType	string	Тип службы рабочего процесса
статус	firmFlowReportResponse.status	string	состояние рабочего процесса
totalDaysAtStep	firmFlowReportResponse.totalDaysAtStep	string	Общее количество дней на шаге рабочего процесса
totalDaysInProcess	firmFlowReportResponse.totalDaysInProcess	string	Общий объем рабочих процессов в днях процесса
workflow	firmFlowReportResponse.workflow	string	Тип рабочего процесса
workflowDescription	firmFlowReportResponse.workflowDescription	string	Описание рабочего процесса
год	firmFlowReportResponse.year	string	год рабочего процесса
getFirmFlowException	getFirmFlowException	string	Получение исключения FirmFlow
pageNumber	pageNumber	string	Номер запроса
pageSize	pageSize	integer	Размер запроса
totalPages	totalPages	integer	всего страниц запроса
totalRecords	totalRecords	integer	Общее количество записей запроса

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
IndexId	indexId	True	string	Введите идентификатор индекса
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
condition	condition	string	значение условия
зависимыйIndexId	dependentIndexId	string	Значение зависимого идентификатора индекса
dynamicRuleId	dynamicRuleId	string	динамическое значение идентификатора правила
value	value	string	value

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

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

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

Параметры

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

Получение дочерних индексов

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
IndexId	indexId	True	string	Введите идентификатор индекса
ListId	listId	True	string	Введите идентификатор списка
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
childIndexId	childIndexId	string	Значение идентификатора дочернего индекса
childListId	childListId	integer	Значение идентификатора дочернего списка
hasChildren	hasChildren	boolean	Имеет ли индекс дочерний индекс
listEntryId	listEntryId	integer	Значение идентификатора записи списка
listId	listId	integer	Значение идентификатора списка
value	value	string	value

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

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
documentAudit	documentAudit	array of	documentAudit
documentHistoryException	documentHistoryException	string	Исключение журнала документов
documentId	documentId	string	Значение идентификатора документа
mergeDocHistory	mergeDocHistory	array of	mergeDocHistory

Получение значений LookupList

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

Получение значений из LookupList

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор ящика. Пример ящика клиентов: "0000000001"	drawerId	True	string	Введите идентификатор ящика
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
clientName	clientName	string	Значение имени клиента
clientNumber	clientNumber	string	Значение номера клиента

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

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

Извлекает индексы документа

Параметры

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

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

Имя	Путь	Тип	Описание
		array of object
indexId	indexId	string	Значение идентификатора индекса
indexValue	indexValue	string	Значение индекса

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
DrawerId	drawerId	True	string	Введите идентификатор ящика
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
childIndexId	childIndexId	string	Значение идентификатора дочернего индекса
indexId	indexId	string	Значение идентификатора индекса
indexName	indexName	string	Значение имени индекса
indexType	indexType	string	Значение типа индекса
length	length	integer	Длина индекса ящика
listId	listId	integer	Значение идентификатора списка
lookupAutoUpdate	lookupAutoUpdate	boolean	Автоматическое обновление подстановки
required	required	boolean	Требуется ли индекс

Получение лицензий

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

Извлекает количество лицензий

Параметры

Имя	Ключ	Обязательно	Тип	Описание
LicenseType	license		string	Ввод типа лицензии
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
assignedLicenses	assignedLicenses	string	Число назначенных лицензий
getLicenseException	getLicenseException	string	Получение исключения лицензии
лицензия	license	string	имя лицензии
сообщение	message	string	сообщение
totalLicenses	totalLicenses	string	общее число лицензий

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

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
clientId	passwordPolicy.clientId	string	Значение идентификатора клиента
forbidden_pwd_words	passwordPolicy.forbidden_pwd_words	array of string	forbidden_pwd_words
lockout_threshold	passwordPolicy.lockout_threshold	integer	Порог блокировки
max_length	passwordPolicy.max_length	integer	максимальная длина пароля
max_login_similarity	passwordPolicy.max_login_similarity	string	максимальное сходство входа
max_pwd_age	passwordPolicy.max_pwd_age	integer	max pwd age of password
max_repeat_chars	passwordPolicy.max_repeat_chars	string	максимальное число повторений символов в пароле
max_sequential_chars	passwordPolicy.max_sequential_chars	string	максимальные последовательные символы
Мид	passwordPolicy.mfa	integer	Значение mfa
min_length	passwordPolicy.min_length	integer	минимальная длина пароля
pwd_req_alpha	passwordPolicy.pwd_req_alpha	integer	Требование альфа-пароля
pwd_req_lower	passwordPolicy.pwd_req_lower	integer	Требование нижнего пароля
pwd_req_number	passwordPolicy.pwd_req_number	integer	Требование к номеру пароля
pwd_req_symbol	passwordPolicy.pwd_req_symbol	integer	Требование пароля символов
pwd_req_upper	passwordPolicy.pwd_req_upper	integer	Требование верхнего пароля
passwordPolicyException	passwordPolicyException	string	passwordPolicyException

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
ТипПользователя	userType		string	Ввод типа пользователя
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
isActive	isActive	boolean	Активен ли пользователь
loginId	loginId	string	Значение идентификатора входа

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
GroupName	groupName		string	Введите имя группы
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
cabinet	cabinet	string	Имя шкафа
add	cabinetPermissions.add	boolean	добавление разрешений
delete	cabinetPermissions.delete	boolean	Удаление разрешений
deny	cabinetPermissions.deny	boolean	запретить разрешения
edit	cabinetPermissions.edit	boolean	изменение разрешений
Поиска	cabinetPermissions.lookUp	boolean	Разрешения подстановки
read	cabinetPermissions.read	boolean	Разрешения на чтение
drawerPermissions	drawerPermissions	array of object	drawerPermissions
ящик	drawerPermissions.drawer	string	Имя ящика
add	drawerPermissions.permission.add	boolean	добавление разрешений
delete	drawerPermissions.permission.delete	boolean	Удаление разрешений
deny	drawerPermissions.permission.deny	boolean	запретить разрешения
edit	drawerPermissions.permission.edit	boolean	изменение разрешений
Поиска	drawerPermissions.permission.lookUp	boolean	Разрешения подстановки
read	drawerPermissions.permission.read	boolean	Разрешения на чтение
groupName	groupName	string	Имя группы
groupPermissionException	groupPermissionException	string	Исключение разрешений группы

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Вход	login	True	string	Введите имя входа
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
cabinet	cabinet	string	Значение имени шкафа
add	cabinetPermission.add	boolean	добавление значения
delete	cabinetPermission.delete	boolean	Удаление значения
deny	cabinetPermission.deny	boolean	запретить значение
edit	cabinetPermission.edit	boolean	изменение значения
Поиска	cabinetPermission.lookUp	boolean	Значение подстановки
read	cabinetPermission.read	boolean	значение чтения
drawerPermissions	drawerPermissions	array of object	drawerPermissions
ящик	drawerPermissions.drawer	string	Значение имени ящика
add	drawerPermissions.permission.add	boolean	добавление значения
delete	drawerPermissions.permission.delete	boolean	Удаление значения
deny	drawerPermissions.permission.deny	boolean	запретить значение
edit	drawerPermissions.permission.edit	boolean	изменение значения
Поиска	drawerPermissions.permission.lookUp	boolean	Значение подстановки
read	drawerPermissions.permission.read	boolean	значение чтения
getUserPermissionException	getUserPermissionException	string	Исключение разрешений пользователя
loginId	loginId	string	Значение идентификатора входа

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

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
uploadLocations	uploadLocations	array of object	uploadLocations
locationName	uploadLocations.locationName	string	Значение имени расположения
locationPath	uploadLocations.locationPath	string	Значение пути расположения
uploadLocationsException	uploadLocationsException	string	Исключение для отправки расположений

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
Имя пользователя для входа	LoginName	True	string	Ввод имени входа
ТипПользователя	UserType	True	string	Выбор UserType

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

Имя	Путь	Тип	Описание
createDate	createDate	string	createDate
создано кем	createdBy	string	создано кем
описание	description	string	описание
disabled	disabled	integer	disabled
disabledByAdmin	disabledByAdmin	boolean	disabledByAdmin
emailNotify	emailNotify	boolean	emailNotify
emailNotifyEventMgmtGroups	emailNotifyEventMgmtGroups	boolean	emailNotifyEventMgmtGroups
emailNotifyEventMgmtUsers	emailNotifyEventMgmtUsers	boolean	emailNotifyEventMgmtUsers
emailNotifyGroup	emailNotifyGroup	boolean	emailNotifyGroup
forcePasswordChange	forcePasswordChange	boolean	forcePasswordChange
fullName	fullName	string	fullName
hasDrawerSetupRights	hasDrawerSetupRights	string	hasDrawerSetupRights
isAdmin	isAdmin	integer	isAdmin
isManager	isManager	integer	isManager
licenseType	licenseType	string	licenseType
locationID	locationID	string	locationID
loginID	loginID	string	loginID
managerFullName	managerFullName	string	managerFullName
managerId	managerId	string	managerId
managerLoginId	managerLoginId	string	managerLoginId
oberonUser	oberonUser	integer	oberonUser
оффлайн	offline	boolean	оффлайн
passwordChangeDate	passwordChangeDate	string	passwordChangeDate
passwordChangeInterval	passwordChangeInterval	integer	passwordChangeInterval
passwordExpireDate	passwordExpireDate	string	passwordExpireDate
reports	reports	boolean	reports
подпись	signature	string	подпись
systemAdmin	systemAdmin	boolean	systemAdmin
taxFlow	taxFlow	boolean	taxFlow
userAdministration	userAdministration	integer	userAdministration
userID	userID	string	userID
workflowManagerUser	workflowManagerUser	boolean	workflowManagerUser

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

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

Возвращает интромацию пользователя

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Имя входа	LoginName	string	Имя входа
Тип пользователя	UserType	string	Тип пользователя

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

Имя	Путь	Тип	Описание
Идентификатор пользователя	userID	string	Идентификатор пользователя
Идентификатор входа	loginID	string	Идентификатор входа
Полное имя	fullName	string	Полное имя
Дата создания	createDate	string	Дата создания
Создано автором	createdBy	string	Создано автором
Description	description	string	Description
Disabled	disabled	integer	Disabled
Отключено администратором	disabledByAdmin	boolean	Отключено администратором
Дата истечения срока действия пароля	passwordExpireDate	string	Дата истечения срока действия пароля
Принудительное изменение пароля	forcePasswordChange	boolean	Принудительное изменение пароля
Дата изменения пароля	passwordChangeDate	string	Дата изменения пароля
Интервал изменения пароля	passwordChangeInterval	integer	Интервал изменения пароля
Тип лицензии	licenseType	string	Тип лицензии
Не в сети	offline	boolean	Не в сети
Отчеты	reports	boolean	Отчеты
Системный администратор	systemAdmin	boolean	Системный администратор
Signature	signature	string	Signature
ИД расположения	locationID	string	ИД расположения
Имеет права на настройку ящика	hasDrawerSetupRights	string	Имеет права на настройку ящика
Налоговый поток	taxFlow	boolean	Налоговый поток
Уведомление по электронной почте	emailNotify	boolean	Уведомление по электронной почте
Группа уведомлений по электронной почте	emailNotifyGroup	boolean	Группа уведомлений по электронной почте
Пользователи Mgmt для уведомлений по электронной почте об уведомлении о событии	emailNotifyEventMgmtUsers	boolean	Пользователи Mgmt для уведомлений по электронной почте об уведомлении о событии
Группы Mgmt событий уведомления по электронной почте	emailNotifyEventMgmtGroups	boolean	Группы Mgmt событий уведомления по электронной почте
Администрирование пользователей портала	portalUserAdministration	boolean	Администрирование пользователей портала
Внутреннее администрирование пользователей	internalUserAdministration	boolean	Внутреннее администрирование пользователей
Пользователь Workflow Manager	workflowManagerUser	boolean	Пользователь Workflow Manager
Идентификатор диспетчера	managerId	string	Идентификатор диспетчера
Идентификатор входа диспетчера	managerLoginId	string	Идентификатор входа диспетчера
Полное имя диспетчера	managerFullName	string	Полное имя диспетчера
Is Manager	isManager	integer	Is Manager
Пользователь Oberon	oberonUser	integer	Пользователь Oberon
Является администратором	isAdmin	integer	Является администратором
Последнее имя входа	lastLogin	string	Последнее имя входа
groups	groups	array of string	groups

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
body	body		array of string

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

Имя	Путь	Тип	Описание
		array of object
documentId	documentId	string	Значение идентификатора документа
documentStatusException	documentStatusException	string	Исключение состояния документа
drawerId	drawerId	string	Значение идентификатора ящика
размер файла	fileSize	string	Значение размера файла
isArchived	isArchived	boolean	— это архивированный документ
isCheckedOut	isCheckedOut	boolean	— это документ, извлеченный из документа
Зашифровано	isEncrypted	boolean	— это документ, зашифрованный
isFiled	isFiled	boolean	— это документ, поданный
isInRedactionQueue	isInRedactionQueue	boolean	— это документ в очереди Redaction
isInTaxsortQueue	isInTaxsortQueue	boolean	— это документ в очереди taxsort
IsLocked	isLocked	boolean	является заблокированным документом
isOfficeDocument	isOfficeDocument	boolean	— документ документа Office Document
isPublished	isPublished	boolean	— документ опубликован
isUndergoingMerging	isUndergoingMerging	boolean	— документ, проходящий слияние
localFile	localFile	string	— документ локального файла
noEdit	noEdit	boolean	значение "Изменить" не
pages	pages	integer	страницы в документе
reviewed	reviewed	boolean	Просмотр состояния
taxSort	taxSort	boolean	— это документ, который является налоговым.
type	type	string	тип файла
version	version	integer	версия документа

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

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

Возвращает все записи для индекса типа списка

Параметры

Имя	Ключ	Обязательно	Тип	Описание
IndexId	indexId	True	string	Введите идентификатор индекса
Токен	X-Authorization		string	Проверка подлинности маркера

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

Имя	Путь	Тип	Описание
		array of object
childIndexId	childIndexId	string	Значение идентификатора дочернего индекса
childListId	childListId	integer	Значение идентификатора дочернего списка
hasChildren	hasChildren	boolean	Имеет ли индекс дочерний индекс
listEntryId	listEntryId	integer	Значение идентификатора записи списка
listId	listId	integer	Значение идентификатора списка
value	value	string	value

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

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
reports	reports	array of object	reports
reportName	reports.reportName	array of string	reportName
тип отчёта	reports.reportType	string	Значение типа отчета
reportsException	reportsException	string	значение исключения отчетов

Получение ящиков

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
		array of object
drawerID	drawerID	string	Значение идентификатора ящика
имя ящика	drawerName	string	Значение имени ящика
add	permissions.add	boolean	добавление значения
delete	permissions.delete	boolean	Удаление значения
edit	permissions.edit	boolean	изменение значения
lookupManagement	permissions.lookupManagement	boolean	Значение lookupManagement
view	permissions.view	boolean	значение представления

Проверка индексов

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
DrawerId	DrawerId	string	Ввод идентификатора ящика
IndexId	IndexId	string	Ввод идентификатора индекса
IndexValue	IndexValue	string	Введите значение индекса

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

Имя	Путь	Тип	Описание
errorMessage	errorMessage	string	сообщение об ошибке
Ошибки	errors	array of	Ошибки
isValid	isValid	boolean	является допустимым индексом

Проверка маркера

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

Проверка состояния токена

Параметры

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

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

response: boolean

Публикация состояния документа

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

Публикация или отмена публикации документов из ClientFlow.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
DocumentId	documentId	True	string	Введите идентификатор документа
Токен	X-Authorization		string	Проверка подлинности маркера
IsPublished	IsPublished	True	string	Указание true или false

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

Имя	Путь	Тип	Описание
		array of object
documentException	documentException	string	Исключение документа
documentId	documentId	string	Значение идентификатора документа
isPublished	isPublished	boolean	— документ опубликован

Рабочий процесс маршрутизации версии 2

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

Рабочий процесс маршрутизации версии 2

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
заявок	filingId	array of integer	заявок
CurrentStep	CurrentStep	array of string	CurrentStep
Завершено	Complete	boolean	Завершено
Дата завершения	CompletedDate	string	Дата завершения
Следующий шаг	NextStep	string	Следующий шаг
Assigned To	AssignedTo	string	Assigned To
Назначенная дата	AssignedDate	string	Назначенная дата
Priority	Priority	string	Priority
Состояние	Status	string	Состояние
Примечание по маршрутизации	RoutingNote	string	Примечание по маршрутизации
Уведомление по электронной почте	emailNotify	boolean	Уведомление по электронной почте

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

Имя	Путь	Тип	Описание
Идентификатор подачи	filingId	string	Идентификатор подачи
Маршрутивируется	isRouted	boolean	Маршрутивируется

Слияние PDF-файлов

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

Объединение PDF-файлов вместе

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
body	body		array of string

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

response: string

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

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
DrawerId	DrawerId	string	Ввод идентификатора ящика
IndexId	IndexId	string	Ввод идентификатора индекса
IndexValue	IndexValue	string	Введите значение индекса

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

Имя	Путь	Тип	Описание
documentId	documentCreate.documentId	string	Значение идентификатора документа
errorMessage	documentCreate.errorMessage	string	сообщение об ошибке
errorMessage	indexValidation.errorMessage	string	сообщение об ошибке
Ошибки	indexValidation.errors	array of	Ошибки
isValid	indexValidation.isValid	boolean	является допустимым документом

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

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

Создает пользователей GoFileRoom и ClientFlow в системе

Параметры

Имя	Ключ	Тип	Описание
ТипПользователя	userType	string	Ввод типа пользователя
Токен	X-Authorization	string	Проверка подлинности маркера
AccountExpiresDate	AccountExpiresDate	string	Введите дату истечения срока действия учетной записи
DisabledComments	DisabledComments	string	Ввод отключенных комментариев
FullName	FullName	string	Полное имя пользователя
Groups	Groups	array of string	Groups
IsAccountExpires	IsAccountExpires	string	Указание true или false
IsAdvanceFlow	IsAdvanceFlow	string	Указание true или false
IsAllowAccessToReports	IsAllowAccessToReports	string	Указание true или false
IsAllowOffline	IsAllowOffline	string	Указание true или false
Отключено	IsDisabled	string	Указание true или false
IsFirmFlow	IsFirmFlow	string	Указание true или false
IsFirmFlowNotificationGroup	IsFirmFlowNotificationGroup	string	Указание true или false
IsFirmFlowNotificationUser	IsFirmFlowNotificationUser	string	Указание true или false
IsMfa	IsMfa	string	Указание true или false
IsUserAdministration	IsUserAdministration	string	Указание true или false
IsWorkflowManagerUser	IsWorkflowManagerUser	string	Указание true или false
LicenseType	LicenseType	string	Ввод типа лицензии
Имя пользователя для входа	LoginName	string	Введите имя входа
ManagerEmail	ManagerEmail	string	Ввод электронной почты диспетчера
Пароль	Password	string	Ввод пароля
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	Указание true или false
IsDenyAll	IsDenyAll	string	Указание true или false
ReportType	ReportType	string	Указание true или false
UploadLocation	UploadLocation	string	Введите расположение отправки

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

Имя	Путь	Тип	Описание
createUserException	createUserException	string	Создание исключения пользователя
isCreated	isCreated	boolean	Создано ли пользователь
mfaException	mfaException	string	Исключение mfa
userId	userId	string	Значение идентификатора пользователя

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

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
Имя ящика	Drawer		string	Имя ящика
Тип службы	ServiceType		string	Тип службы
Идентификатор папки	folderId		string	Идентификатор папки
Имя клиента	ClientName		string	Имя клиента
Номер клиента	ClientNumber		string	Номер клиента
Тип взаимодействия	EngagementType		string	Тип взаимодействия
РИС	PIC		string	РИС
Год	Year		string	Год
Окончание периода	PeriodEnd		string	Окончание периода
Имя рабочего процесса	workflowName		string	Имя рабочего процесса
Description	description	True	string	Description
Название статуса	statusName		string	Название статуса
Доставить действие	action		string	Доставить действие
Текущая дата выполнения	currentduedate		string	Текущая дата выполнения
Исходная дата выполнения	originalduedate		string	Исходная дата выполнения
Доставить форму	form		string	Доставить форму
Метод доставки	Delivery		string	Метод доставки
Место назначения	Destination		string	Место назначения
Исходный документ	sourceDocument		string	Исходный документ
Действие заметки	action		string	Действие заметки
Тип заметки	noteType		string	Тип заметки
Сообщение о заметках	note		string	Сообщение о заметках
Имя поля сведений	name		string	Имя поля сведений
Значение поля сведений	value		string	Значение поля сведений
Ответственное поле	ResponsibleField		string	Ответственное поле
Значение ответственного поля	value		string	Значение ответственного поля

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

Имя	Путь	Тип	Описание
Идентификатор подачи	filingId	integer	Идентификатор подачи
Комментарий об ошибке	errorComment	string	Комментарий об ошибке
Состояние	status	boolean	Состояние
errorMessage	errorMessage	array of string	errorMessage

Создать группу

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

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

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
AccessToApproveDocsOnly	AccessToApproveDocsOnly	string	Указание true или false
AllowAccessToReports	AllowAccessToReports	string	Указание true или false
Comments	Comments	string	Ввод примечаний
EnableMfa	EnableMfa	string	Указание true или false
EnforceMfaForUsers	EnforceMfaForUsers	string	Указание true или false
FirmFlowRoutingNotification	FirmFlowRoutingNotification	string	Указание true или false
FullAccessToDocTracking	FullAccessToDocTracking	string	Указание true или false
GroupName	GroupName	string	Введите имя группы
MfaRequired	MfaRequired	string	Указание true или false
PermissonToApproveDocs	PermissonToApproveDocs	string	Указание true или false
Allow	Allow	array of string	Allow
Deny	Deny	array of string	Deny
IsAllowAll	IsAllowAll	string	Указание true или false
IsDenyAll	IsDenyAll	string	Указание true или false
ReportType	ReportType	string	Указание true или false
UploadLocation	UploadLocation	string	Введите расположение отправки
Users	Users	array of string	Users

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

Имя	Путь	Тип	Описание
createGroupException	createGroupException	string	Создание исключения группы
groupId	groupId	string	Значение идентификатора группы
isCreated	isCreated	boolean	Созданная группа
mfaException	mfaException	string	Состояние mfa

Удаление главного доставить

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

Удаление главного доставить

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
Тип службы	ServiceType	string	Тип службы
Имя ящика	DrawerName	string	Имя ящика
Конечные имена	DeliverableNames	array of string	Конечные имена

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

Имя	Путь	Тип	Описание
		array of object
Состояние удаления	isDeleted	boolean	Состояние удаления
Ответное сообщение	responseMessage	string	Ответное сообщение

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

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

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

Параметры

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

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

Имя	Путь	Тип	Описание
		array of object
deleteDocumentException	deleteDocumentException	string	Удаление исключения документов
documentId	documentId	string	Значение идентификатора документа
isDeleted	isDeleted	boolean	является удаленным документом

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

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

Удаление пользователей GoFileRoom и ClientFlow из системы

Параметры

Имя	Ключ	Тип	Описание
Токен	X-Authorization	string	Проверка подлинности маркера
LoginId	LoginId	string	Введите идентификатор входа пользователя
ТипПользователя	UserType	string	Введите тип пользователя

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

Имя	Путь	Тип	Описание
deleteUserException	deleteUserException	string	Удаление исключения пользователя
isDeleted	isDeleted	boolean	Удалено ли имя входа
loginId	loginId	string	Значение идентификатора входа

Удаление рабочих процессов

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

Удаление рабочих процессов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Токен	X-Authorization		string	Проверка подлинности маркера
заявок	filingId		array of integer	заявок

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

Имя	Путь	Тип	Описание
Удаленное состояние	isDeleted	boolean	Удаленное состояние
Идентификатор подачи	filingId	string	Идентификатор подачи