Egnyte

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

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

Услуга 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)
Контакт
Имя Поддержка Egnyte
URL https://helpdesk.egnyte.com
Адрес электронной почты support@egnyte.com
Метаданные соединителя
Publisher Egnyte
Веб-сайт https://egnyte.com/
Политика конфиденциальности https://www.egnyte.com/privacy-policy
Категории Сотрудничество; Продуктивность

Egnyte

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

Pre-requisites

Чтобы использовать соединитель, необходимо быть пользователем Egnyte.

Поддерживаемые действия

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

Поддерживаемые триггеры

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

  • When a file is locked: эта операция активирует поток при блокировке файла
  • When a file is unlocked: эта операция активирует поток при разблокировке файла
  • When a file is updated: эта операция активирует поток при обновлении файла в определенной папке
  • When a file is created (webhook): эта операция активирует поток при создании файла в определенной папке
  • When a share link is created: эта операция активирует поток при создании ссылки общего ресурса
  • When a share link is deleted: эта операция активирует поток при удалении ссылки общего ресурса
  • When the file or folder permission changes: эта операция активирует поток при изменении разрешений файла или папки
  • When the file or folder metadata changes: эта операция активирует поток при изменении метаданных файла или папки
  • When a project folder is created: эта операция активирует поток при создании папки проекта или при добавлении существующей папки в качестве папки проекта
  • When a folder is unmarked as a project: эта операция активирует поток, когда папка не отмечена как проект
  • When a project is updated: эта операция активирует поток при обновлении проекта
  • When a workflow is created: эта операция активирует поток при создании рабочего процесса.
  • When a workflow is completed: эта операция активирует поток при завершении рабочего процесса.
  • When an approval type workflow is approved: эта операция активирует поток при утверждении рабочего процесса типа утверждения
  • When an approval type workflow is rejected: эта операция активирует поток при отклонении рабочего процесса типа утверждения
  • When a group is created: эта операция активирует поток при создании группы
  • When a group is updated: эта операция активирует поток при обновлении группы
  • When a group is deleted: эта операция активирует поток при удалении группы
  • When a file is created (polling): эта операция активирует поток при создании нового файла в папке.
  • When a folder is created: эта операция активирует поток при создании вложенной папки в папке.
  • When a file is deleted: эта операция активирует поток при удалении файла в папке.
  • When a folder is deleted: эта операция активирует поток при удалении вложенной папки в папке.
  • When a file is renamed: эта операция активирует поток при переименовании файла в папке.
  • When a folder is renamed: эта операция активирует поток, когда вложенная папка переименована в папку.
  • When a file is moved: эта операция активирует поток при перемещении файла в папку.
  • When a folder is moved: эта операция активирует поток при перемещении вложенной папки в папку.
  • When a file is copied: эта операция активирует поток при копировании файла в папку.
  • When a folder is copied: эта операция активирует поток при копировании вложенной папки в папку.

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

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

Действия

[ИИ] Гибридный поиск

Предоставляет мощные возможности поиска, которые объединяют традиционный поиск на основе ключевых слов с семантическим (вектором) поиска, чтобы обеспечить более релевантные результаты. https://developers.egnyte.com/api-docs/read/ai-api#Hybrid-Search
[ИИ] Задайте вопрос Egnyte Copilot

Задайте вопросы для платформы copilot, предоставляя ответ на основе искусственного интеллекта на основе глобального содержимого в домене Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[ИИ] Задать вопрос агенту

Позволяет пользователям задавать вопрос конкретному агенту, предоставляя ответ на основе искусственного интеллекта на основе конфигурации агента. https://developers.egnyte.com/api-docs/read/agent-api#Ask-a-Question-to-Agent
[ИИ] Задать вопрос базе знаний

Позволяет пользователям задавать вопросы определенной базе знаний (КБ), предоставляя ответ на основе искусственного интеллекта на основе содержимого этой базы знаний. https://developers.egnyte.com/api-docs/read/ai-api#Ask-Knowledge-Base
[ИИ] Задать вопрос о документе

Задайте вопросы, связанные с данным документом, предоставляя ответ на основе искусственного интеллекта на основе содержимого документа. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
[ИИ] Перечисление баз знаний

Позволяет пользователям получать список баз знаний (КБ), доступных в домене Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Knowledge-Base-Listing
[ИИ] Получение состояния выполнения агента

Позволяет пользователям получать состояние и ответ от ранее запрошенного выполнения агента. https://developers.egnyte.com/api-docs/read/agent-api#Agent-Execution-Status
[ИИ] Создание сводки для документа

Создайте сводку для данного документа, предоставляя ответ на основе искусственного интеллекта на основе содержимого документа. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
[ИИ] Список доступных агентов

Позволяет пользователям получать список доступных настраиваемых агентов. https://developers.egnyte.com/api-docs/read/agent-api#List-agents
Блокировка файла по идентификатору

Блокировка файла с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Блокировка файла по пути

Блокировка файла с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
Глубокая ссылка по идентификатору

Создайте глубокую ссылку для файла или папки по идентификатору. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Глубокая ссылка по пути

Создайте глубокую ссылку для файла или папки по пути. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
Изменение параметров папки

Изменение параметров папки, таких как описание, параметры общего доступа к ссылке, разрешения на общедоступные ссылки, ограничения перемещения и удаления и настройки уведомлений по электронной почте. https://developers.egnyte.com/api-docs/read/folder-options-api
Копирование папки по идентификатору

Скопируйте папку с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Копирование папки по пути

Скопируйте папку с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Копирование файла по идентификатору

Скопируйте файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Копирование файла по пути

Скопируйте файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
Настройка метаданных по идентификатору папки

Запись метаданных в папку с помощью идентификатора папки. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Настройка метаданных по идентификатору файла

Запись метаданных в файл с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
Настройка разрешений папки

Задайте разрешения для папки. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
Обновление атрибутов пространства имен

Обновляет атрибуты пространства имен. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
Обновление ключей пространства имен

Обновите ключ пользовательских метаданных для домена. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
Обновление пользователя по идентификатору

Обновите одного пользователя. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
Обновление проекта по идентификатору

Обновляет указанные свойства проекта, определяемого его идентификатором. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
Общий доступ к файлу

Предоставление общего доступа к файлу в Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Отображение сведений о ссылке

Просмотр сведений о ссылке. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details
Очистка проекта по идентификатору

Эта конечная точка инициирует очистку проекта и при необходимости удаляет или отключает указанных пользователей. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
Папка общего доступа

Предоставление общего доступа к папке в Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Перемещение папки по идентификатору

Перемещение папки с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Перемещение папки по пути

Перемещение папки в Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Перемещение файла по идентификатору

Перемещение файла в Egnyte с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Перемещение файла по пути

Перемещение файла в Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
Поиск версии 1

Найдите содержимое, хранящееся в Egnyte на основе имен файлов, метаданных и текстового содержимого. https://developers.egnyte.com/api-docs/read/search-api#Search-v1
Поиск версии 2

Найдите содержимое с расширенными возможностями поиска. https://developers.egnyte.com/api-docs/read/search-api#Search-v2
Поиск метаданных

Поиск элементов с определенным полем метаданных или значением. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
Полное обновление группы

Перезапись всех атрибутов группы. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
Получение всех проектов

Вывод списка всех папок проекта в домене. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
Получение всех пространств имен

Получите список всех пользовательских пространств имен метаданных в домене. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
Получение действующих разрешений

Получение эффективных разрешений для пользователя. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
Получение метаданных по идентификатору папки

Получение метаданных из папки с помощью идентификатора папки. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Получение метаданных по идентификатору файла

Получение метаданных из файла с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
Получение проекта по идентификатору

Получение проекта с помощью идентификатора. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
Получение проекта по идентификатору корневой папки

Получение проекта на основе идентификатора корневой папки. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
Получение пространства имен

Перечислить все пользовательские ключи метаданных, созданные в заданном пространстве имен. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
Получение разрешений на папку

Получение разрешений для папки. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
Получение сведений о группе

Получение сведений о группе с помощью идентификатора. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
Получение сведений о папке по идентификатору

Получение сведений о папке с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Получение сведений о папке по пути

Получение сведений о папке с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Получение сведений о пользователе

Извлеките сведения о пользователе по идентификатору. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
Получение сведений о файле по идентификатору

Получение сведений о файле с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Получение сведений о файле по пути

Получение сведений о файле с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
Получение содержимого файла по идентификатору

Извлекает содержимое файла из Egnyte с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Получение содержимого файла по пути

Извлекает содержимое файла из Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
Получение списка всех групп

Получение списка групп. https://developers.egnyte.com/api-docs/read/group-management#List-Groups
Получение списка всех пользователей

Получение сведений о пользователях. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
Пометить папку как проект

Помечайте существующую папку как проект. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
Разблокировка файла по идентификатору

Разблокируйте файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Разблокировка файла по пути

Разблокируйте файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
Создание группы

Создайте группу в Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
Создание ключа метаданных

Добавьте ключ метаданных в существующее пространство имен. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
Создание пользователя

Создайте пользователя в Egnyte. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
Создание проекта из шаблона

Создайте проект из шаблона папки проекта. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
Создание пространства имен

Создайте пространство имен в Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
Создать папку

Создайте папку в Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
Создать ссылку

Создайте ссылку. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
Создать файл

Отправляет файл в Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
Список всех ссылок

Выводит список всех ссылок, кроме удаленных ссылок. Обратите внимание, что если пользователь, выполняющий этот метод, не является администратором, будут перечислены только ссылки, созданные пользователем. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
Список всех ссылок версии 2

Выводит список всех ссылок. Обратите внимание, что если пользователь, выполняющий этот метод, не является администратором, будут перечислены только ссылки, созданные пользователем. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
Удаление группы

Удаление группы по идентификатору. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
Удаление ключа метаданных

Удалите ключ метаданных из существующего пространства имен. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
Удаление папки по идентификатору

Удалите папку с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Удаление папки по пути

Удалите папку с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Удаление пользователя по идентификатору

Удаление пользователя из Egnyte. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
Удаление проекта по идентификатору

Удалите проект на основе его идентификатора. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
Удаление пространства имен

Удалите указанное пространство имен. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
Удаление файла по идентификатору

Удалите файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Удаление файла по пути

Удалите файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
Удалить ссылку

Удаление ссылки. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
Частичное обновление группы

Обновите определенные атрибуты группы. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

[ИИ] Гибридный поиск

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

Предоставляет мощные возможности поиска, которые объединяют традиционный поиск на основе ключевых слов с семантическим (вектором) поиска, чтобы обеспечить более релевантные результаты. https://developers.egnyte.com/api-docs/read/ai-api#Hybrid-Search

Параметры

Имя Ключ Обязательно Тип Описание
Семантический вес
 semanticWeight True float

Баланс между ключевым словом и семантическим поиском. Диапазон: 0.0 (чистое ключевое слово) до 1.0 (чистая семантика)
Query
 query True string

Текст поискового запроса. Должно быть от 3 до 250 символов.
Путь к папке
 folderPath string

Ограничивает поиск по определенному пути к папке
Идентификатор коллекции
 collectionId string

Ограничивает поиск определенной коллекцией (КБ)
Создано автором
 createdBy string

Фильтрует результаты по имени пользователя создателя
Создано после
 createdAfter integer

Фильтрует результаты для элементов, созданных после этого метки времени (эпоха Unix в миллисекундах)
Создано раньше
 createdBefore integer

Фильтрует результаты для элементов, созданных до этого метки времени (эпоха Unix в миллисекундах)
Лимит
 limit integer

Максимальное количество возвращаемых результатов. Диапазон: 1–1000. Значение по умолчанию — 100.
Предпочтительный путь к папке
 preferredFolderPath string

Повышение результатов из пути к этой папке
Исключить пути к папкам
 excludeFolderPaths array of string

Исключает результаты из этих путей к папкам
Пути к папкам
 folderPaths array of string

Включает результаты только из этих путей к папкам
Идентификаторы записей
 entryIds array of string

Ограничивает поиск идентификаторами определенных записей
Включение защиты искусственного интеллекта
 enableAISafeguards boolean

Включите оценку политик защиты ИИ. Защищенные записи будут отфильтрованы из результатов.

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

Тело
HybridSearchResponse

[ИИ] Задайте вопрос Egnyte Copilot

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

Задайте вопросы для платформы copilot, предоставляя ответ на основе искусственного интеллекта на основе глобального содержимого в домене Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Copilot

Параметры

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

Конкретный вопрос, который вы хотите задать
Идентификатор папки
 id string

Идентификатор выбранной папки
Идентификатор записи файла
 entryId string

Идентификатор записи выбранного файла
Включение ссылок
 includeCitations boolean

Должен ли ответ включать ссылки (по умолчанию — false)
Role
 role string
Содержимое сообщения
 content string

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

Тело
AICopilotResponse

[ИИ] Задать вопрос агенту

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

Позволяет пользователям задавать вопрос конкретному агенту, предоставляя ответ на основе искусственного интеллекта на основе конфигурации агента. https://developers.egnyte.com/api-docs/read/agent-api#Ask-a-Question-to-Agent

Параметры

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

Уникальный идентификатор агента для запроса
Question
 question True string

Конкретный вопрос, который пользователь хочет попросить агента (максимум 35000 символов)
Инструкции
 instructions string

Необязательная инструкция по реагированию агента (системный запрос)
ID разговора
 conversationId string

Идентификатор беседы для поддержания контекста с несколькими поворотами. Опустить первый вопрос.
Role
 role string
Содержимое сообщения
 content string
Идентификаторы записей
 entryIds array of string

Простой плоский массив идентификаторов записей файлов
Идентификатор папки
 id string

Идентификатор выбранной папки
Идентификатор записи файла
 entryId string

Идентификатор записи выбранного файла

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

Тело
AskAgentResponse

[ИИ] Задать вопрос базе знаний

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

Позволяет пользователям задавать вопросы определенной базе знаний (КБ), предоставляя ответ на основе искусственного интеллекта на основе содержимого этой базы знаний. https://developers.egnyte.com/api-docs/read/ai-api#Ask-Knowledge-Base

Параметры

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

Уникальный идентификатор базы знаний (КБ)
Question
 question True string

Конкретный вопрос, который вы хотите задать
Включение ссылок
 includeCitations boolean

Должен ли ответ включать ссылки (по умолчанию — false)
Role
 role string
Содержимое сообщения
 content string

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

Тело
AICopilotResponse

[ИИ] Задать вопрос о документе

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

Задайте вопросы, связанные с данным документом, предоставляя ответ на основе искусственного интеллекта на основе содержимого документа. https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

Параметры

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

Идентификатор конкретной версии файла
Question
 question True string

Конкретный вопрос, который вы хотите задать
Включение ссылок
 includeCitations boolean

Должен ли ответ включать ссылки (по умолчанию — false)
Role
 role string
Содержимое сообщения
 content string

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

Тело
AIQuestionResponse

[ИИ] Перечисление баз знаний

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

Позволяет пользователям получать список баз знаний (КБ), доступных в домене Egnyte. https://developers.egnyte.com/api-docs/read/ai-api#Knowledge-Base-Listing

Параметры

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

Критерии сортировки результатов
Направление сортировки
 sortDirection True string

Направление сортировки результатов
Состояние
 status True string

Состояние извлекаемой базы знаний
Страница
 page integer

Номер страницы для получения в ответе с разбивкой на страницы
Size
 size integer

Количество элементов на страницу в ответе с разбивкой на страницы
Создано автором
 createdBy string

Идентификатор пользователя, создавшего базу знаний. Результаты будут отфильтрованы по этому идентификатору.
Создано после
 createdAfter integer

Фильтр для получения ключевых объектов, созданных после указанной метки времени (в миллисекундах)
Создано раньше
 createdBefore integer

Фильтр для получения ключевых объектов, созданных до указанной метки времени (в миллисекундах)
Включение заполнителей данных
 includePlaceholderData boolean

Если значение true, в ответе содержатся данные заполнителя.
Включение статистики обработки
 includeProcessingStatistics boolean

Если значение true, включает статистику обработки в ответе
Включение запросов
 includePrompts boolean

Если значение true, содержит данные, связанные с запросом, в ответе

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

Тело
KnowledgeBaseListResponse

[ИИ] Получение состояния выполнения агента

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

Позволяет пользователям получать состояние и ответ от ранее запрошенного выполнения агента. https://developers.egnyte.com/api-docs/read/agent-api#Agent-Execution-Status

Параметры

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

Уникальный идентификатор агента
Идентификатор запроса
 requestId True string

Уникальный идентификатор запроса на выполнение агента

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

Тело
AgentExecutionStatusResponse

[ИИ] Создание сводки для документа

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

Создайте сводку для данного документа, предоставляя ответ на основе искусственного интеллекта на основе содержимого документа. https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

Параметры

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

Идентификатор конкретной версии файла
Role
 role string
Содержимое сообщения
 content string

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

Тело
AISummaryResponse

[ИИ] Список доступных агентов

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

Позволяет пользователям получать список доступных настраиваемых агентов. https://developers.egnyte.com/api-docs/read/agent-api#List-agents

Параметры

Имя Ключ Обязательно Тип Описание
Сортировка по
 sortBy string

Поле для сортировки результатов по (по умолчанию: имя)
Порядок сортировки
 sortOrder string

Порядок сортировки (по умолчанию: asc)

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

Список доступных агентов

Товары
AgentListResponse

Блокировка файла по идентификатору

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

Блокировка файла с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Параметры

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

Уникальный идентификатор файла в Egnyte.

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

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

Время в секундах, на которое должен быть заблокирован файл.
Маркер блокировки
 lock_token string

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

Блокировка файла по пути

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

Блокировка файла с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

Параметры

Имя Ключ Обязательно Тип Описание
Путь к целевому файлу
 path True string

Путь к целевому файлу в Egnyte, включая имя целевого файла.

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

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

Время в секундах, на которое должен быть заблокирован файл.
Маркер блокировки
 lock_token string

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

Глубокая ссылка по идентификатору

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

Создайте глубокую ссылку для файла или папки по идентификатору. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Параметры

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

Идентификатор файла или папки
Тип
 type True string

Тип ссылки

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

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

Глубокая ссылка

Глубокая ссылка по пути

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

Создайте глубокую ссылку для файла или папки по пути. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

Параметры

Имя Ключ Обязательно Тип Описание
Путь
 path True string

Путь к файлу или папке

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

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

Глубокая ссылка

Изменение параметров папки

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

Изменение параметров папки, таких как описание, параметры общего доступа к ссылке, разрешения на общедоступные ссылки, ограничения перемещения и удаления и настройки уведомлений по электронной почте. https://developers.egnyte.com/api-docs/read/folder-options-api

Параметры

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

Уникальный путь к папке в Egnyte.
Описание папки
 folder_description string

Описание папки.
Разрешить ссылки
 allow_links boolean

Выберите, могут ли ссылки быть общими для файлов или вложенных папок в этой папке.
Общедоступные ссылки
 public_links string

Укажите тип общедоступных ссылок. Возможные значения: files_folders, файлы, отключенные.
Ограничение перемещения и удаления
 restrict_move_delete boolean

Ограничить операции перемещения и удаления только владельцам папок и администраторам.
Уведомления об обновлениях содержимого
 content_updates boolean

Включите уведомления по электронной почте для обновлений содержимого.
Уведомления с доступом к содержимому
 content_accessed boolean

Включите уведомления по электронной почте для доступа к содержимому.

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

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

Имя папки.
Последнее изменение
 lastModified integer

Последнее время изменения любого файла в папке (но не в вложенных папках).
Путь к папке
 path string

Полный путь к папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор папки.
Описание папки
 folder_description string

Описание папки.
Папка Is
 is_folder boolean

Указывает, является ли ресурс папкой. Истина или Ложь
Возможные общедоступные ссылки
 public_links string

Параметр папки указывает, как было задано значение "Разрешить общедоступные ссылки из этой папки".
Можно удалить или переместить
 restrict_move_delete boolean

Можно ли удалить или переместить? T или F

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

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

Скопируйте папку с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Параметры

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

Уникальный идентификатор папки для копирования в Egnyte.
Путь к папке назначения
 destination_path True string

Путь к целевой папке в Egnyte.

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

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

Полный путь к скопированной папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор скопированной папки.

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

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

Скопируйте папку с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Параметры

Имя Ключ Обязательно Тип Описание
Путь к исходной папке
 path True string

Путь к исходной папке в Egnyte.
Путь к папке назначения
 destination_path True string

Путь к целевой папке в Egnyte.

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

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

Полный путь к скопированной папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор скопированной папки.

Копирование файла по идентификатору

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

Скопируйте файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Параметры

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

Уникальный идентификатор файла для копирования в Egnyte.
Путь к целевому файлу
 destination_path True string

Путь к целевому файлу в Egnyte, включая имя целевого файла.

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

Имя Путь Тип Описание
Путь к файлу
 path string

Полный путь скопированного файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.

Копирование файла по пути

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

Скопируйте файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

Параметры

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

Путь к исходному файлу в Egnyte, включая имя целевого файла.
Целевой файл
 destination_path True string

Путь к целевому файлу в Egnyte, включая имя целевого файла.

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

Имя Путь Тип Описание
Путь к файлу
 path string

Полный путь скопированного файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.

Настройка метаданных по идентификатору папки

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

Запись метаданных в папку с помощью идентификатора папки. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Параметры

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

Уникальный идентификатор папки в Egnyte.
Имя пространства имен
 namespaceName True string

Имя пространства имен.
Имя ключа метаданных
 metadataName True string

Имя ключа, которому нужно назначить значение.
Значение метаданных
 metadataValue True string

Значение метаданных, которое необходимо задать.

Настройка метаданных по идентификатору файла

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

Запись метаданных в файл с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

Параметры

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

Уникальный идентификатор файла в Egnyte.
Имя пространства имен
 namespaceName True string

Имя пространства имен.
Имя ключа метаданных
 metadataName True string

Имя ключа, которому нужно назначить значение.
Значение метаданных
 metadataValue string

Значение метаданных, которое необходимо задать.

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

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

Задайте разрешения для папки. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

Параметры

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

Полный путь к папке.
Разрешения пользователя
 userPerms object

Сопоставление пользователя со значением разрешения.
Разрешения группы
 groupPerms object

Сопоставление имени группы со значением разрешения
Наследует разрешения
 inheritsPermissions boolean

Следует ли наследовать разрешения из родительской папки.
Сохраняйте родительские разрешения (только если наследованиеPermissions равно false)
 keepParentPermissions boolean

Должны ли разрешения из родительских папок применяться к этой папке.

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

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

Обновляет атрибуты пространства имен. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.
отображаемое имя
 displayName string

Имя для идентификации пространства имен в пользовательском интерфейсе
Приоритеты
 priorities object

Задает приоритет (порядок) для ключей. Ключи будут отображаться в соответствии с их приоритетами в порядке убывания (ключи с более высоким приоритетом будут отображаться сначала)

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

Тело
NamespaceItem

Обновление ключей пространства имен

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

Обновите ключ пользовательских метаданных для домена. https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.
Key
 key True string

Уникальный ключ в пространстве имен
отображаемое имя
 displayName string

Указывает имя, отображаемое для ключа
type
 type string

Указывает тип данных для ключа
priority
 priority number

Задает приоритет (порядок) для ключей. Ключи будут отображаться в соответствии с их приоритетами в порядке убывания (ключи с более высоким приоритетом будут отображаться сначала)
данные
 data string

Для ключа типа перечисления указывает перечисленные значения
helpText
 helpText True string

Описание поля метаданных для релевантности поиска и обработки ИИ (20–200 символов)

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

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

Имя пространства имен
key
 key string

Имя ключа
отображаемое имя
 displayName string

Имя для идентификации поля в пользовательском интерфейсе
helpText
 helpText string

Описание поля метаданных для релевантности поиска и обработки ИИ (20–200 символов)
priority
 priority number

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

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

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

Обновите одного пользователя. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

Параметры

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

Уникальный идентификатор пользователя
Электронная почта пользователя
 email string

Адрес электронной почты пользователя.
Личное имя
 givenName string

Имя пользователя.
Фамилия
 familyName string

Фамилия пользователя.
Active
 active boolean

Является ли пользователь активным или неактивным.
Отправка приглашения
 sendInvite boolean

Если задано значение true, будет отправлено сообщение электронной почты приглашения. Параметр не может быть единственным, измененным этим действием.
Language
 language string

Параметр "language" принимается только в том случае, если языковой пакет включен для домена.
Тип проверки подлинности
 authType string

Тип проверки подлинности для пользователя.
Тип пользователя
 userType string

Тип пользователя.
Role
 role string

Роль, назначенная пользователю. Применимо только для Power Users.
Идентификатор пользователя поставщика удостоверений
 idpUserId string

Требуется только в том случае, если пользователь прошел проверку подлинности единого входа и не использует сопоставление пользователей по умолчанию
Основное имя пользователя
 userPrincipalName string

Не указывайте, не прошел ли пользователь проверку подлинности AD.

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

Имя Путь Тип Описание
Идентификатор пользователя
 id integer

Уникальный идентификатор пользователя
Электронная почта пользователя
 email string

Адрес электронной почты пользователя.
Фамилия
 familyName string

Фамилия пользователя.
Личное имя
 givenName string

Имя пользователя.
Active
 active boolean

Является ли пользователь активным или неактивным.
Отправка приглашения
 sendInvite boolean

Если задано значение true, будет отправлено сообщение электронной почты приглашения.
Language
 language string

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

Тип проверки подлинности для пользователя.
Тип пользователя
 userType string

Тип пользователя.
Role
 role string

Роль, назначенная пользователю. Применимо только для Power Users.
Идентификатор пользователя поставщика удостоверений
 idpUserId string

Требуется только в том случае, если пользователь прошел проверку подлинности единого входа
Основное имя пользователя
 userPrincipalName string

Не указывайте, не прошел ли пользователь проверку подлинности AD.

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

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

Обновляет указанные свойства проекта, определяемого его идентификатором. https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

Параметры

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

Новое имя папки.
описание
 description string

Новое описание папки.
projectId
 projectId True string

ID проекта.
customProjectId
 customProjectId string

Пользовательский идентификатор проекта.
ИмяКлиента
 customerName string

Клиент, связанный с проектом.
улицаАдрес1
 streetAddress1 string

Первая строка адреса улицы.
улицаАдрес2
 streetAddress2 string

Вторая строка адреса улицы.
city
 city string

Город.
государство
 state string

Область, республика, край, округ.
postalCode
 postalCode string

Почтовый индекс.
country
 country string

используя код страны 3 символа из профиля GENC ISO 3166, например США, GBR, POL.
статус
 status True string

Текущее состояние проекта.
startDate
 startDate string

Дата начала проекта в формате ISO 8601.
завершениеДата
 completionDate string

Ожидаемая дата завершения проекта в формате ISO 8601.

Общий доступ к файлу

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

Предоставление общего доступа к файлу в Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Параметры

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

Путь к файлу в Egnyte, включая целевое имя файла для общего доступа.

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

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

Links
Идентификатор ссылки
 links.id string

Идентификатор ссылки.
URL-адрес ссылки
 links.url string

Полный URL-адрес ссылки.
Получатели
 links.recipients array of string

Массив допустимых адресов электронной почты, на которые была отправлена ссылка.
Путь к файлу
 path string

Полный путь к общему файлу.
Тип
 type string

Тип ссылки, файла, папки или отправки.
Доступность
 accessibility string

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

Будет ли создатель ссылки получать уведомления по электронной почте при доступе к ссылке.
Ссылается на версию
 link_to_current boolean

Эта текущая версия? T или F
Дата окончания срока действия
 expiry_date string

Дата и время истечения срока действия ссылки.
Дата создания
 creation_date string

Дата и время создания ссылки.
Создано автором
 created_by string

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

Отображение сведений о ссылке

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

Просмотр сведений о ссылке. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

Параметры

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

LinkId

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

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

Массив, содержащий полные сведения json для всех ссылок для домена, которые этот пользователь может видеть в любом указанном диапазоне.
Идентификатор
 links.id string

Идентификатор ссылки
URL-адрес
 links.url string

Полный URL-адрес ссылки
Получатели
 links.recipients array of string

Массив допустимых адресов электронной почты, на которые была отправлена ссылка.
Путь
 path string

Абсолютный путь к целевому ресурсу либо файлу, либо папке.
Тип
 type string

Тип ссылки, файла, папки или отправки
Доступность
 accessibility string

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

Логическое значение о том, будет ли создатель ссылки получать уведомления по электронной почте при доступе к ссылке.
Ссылка на текущую
 link_to_current boolean

Логическое значение, указывающее, будет ли ссылка всегда ссылаться на текущую версию файла. Применимо только для ссылок на файлы.
Дата окончания срока действия
 expiry_date string

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

Дата и время создания ссылки
Кем создано:
 created_by string

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

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

Очистка проекта по идентификатору

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

Эта конечная точка инициирует очистку проекта и при необходимости удаляет или отключает указанных пользователей. https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

Параметры

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

Код проекта
deleteLinks
 deleteLinks True boolean

Если задано значение true, все существующие активные ссылки в проекте будут удалены.
usersToDelete
 usersToDelete array of integer

Список идентификаторов пользователей, которые нужно удалить.
usersToDisable
 usersToDisable array of integer

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

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

Имя Путь Тип Описание
сообщение
 message string

Сообщение о состоянии

Папка общего доступа

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

Предоставление общего доступа к папке в Egnyte. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Параметры

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

Путь к папке в Egnyte для общего доступа.

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

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

Links
Идентификатор ссылки
 links.id string

Идентификатор ссылки.
URL-адрес ссылки
 links.url string

Полный URL-адрес ссылки.
Получатели
 links.recipients array of string

Массив допустимых адресов электронной почты, на которые была отправлена ссылка.
Путь к папке
 path string

Полный путь к общей папке.
Тип
 type string

Тип ссылки, файла, папки или отправки.
Доступность
 accessibility string

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

Будет ли создатель ссылки получать уведомления по электронной почте при доступе к ссылке.
Ссылается на версию
 link_to_current boolean

Эта текущая версия? T или F
Дата окончания срока действия
 expiry_date string

Дата и время истечения срока действия ссылки.
Дата создания
 creation_date string

Дата и время создания ссылки.
Кем создано:
 created_by string

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

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

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

Перемещение папки с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Параметры

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

Уникальный идентификатор папки в Egnyte.
Путь к папке назначения
 destination_path True string

Путь к целевой папке в Egnyte.

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

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

Полный путь к перемещаемой папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор перемещаемой папки.

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

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

Перемещение папки в Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Параметры

Имя Ключ Обязательно Тип Описание
Исходный путь
 path True string

Путь к исходной папке.
Путь к папке назначения
 destination_path True string

Путь к целевой папке в Egnyte.

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

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

Полный путь к перемещаемой папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор перемещаемой папки.

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

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

Перемещение файла в Egnyte с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Параметры

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

Уникальный идентификатор файла в Egnyte.
Путь к целевому файлу
 destination_path True string

Путь к целевому файлу в Egnyte. Включая целевое имя файла.

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

Имя Путь Тип Описание
Путь к файлу
 path string

Полный путь к перемещаемого файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.

Перемещение файла по пути

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

Перемещение файла в Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

Параметры

Имя Ключ Обязательно Тип Описание
Исходный путь
 path True string

Путь к исходному файлу.
Путь к целевому файлу
 destination_path True string

Путь к целевому файлу в Egnyte, включая имя целевого файла.

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

Имя Путь Тип Описание
Путь к файлу
 path string

Полный путь к перемещаемого файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.

Поиск версии 1

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

Найдите содержимое, хранящееся в Egnyte на основе имен файлов, метаданных и текстового содержимого. https://developers.egnyte.com/api-docs/read/search-api#Search-v1

Параметры

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

Строка поиска, которую вы хотите найти.
Включение защиты искусственного интеллекта
 enableAISafeguards boolean

Включите оценку политик защиты ИИ. Защищенные записи будут отфильтрованы из результатов.
Смещение
 offset integer

0-й индекс запрашиваемой начальной записи.
Численность
 count integer

Количество записей на страницу.
Folder
 folder string

Ограничить результаты элементами в указанной папке и потомках.
Изменено до
 modifiedBefore string

Ограничить результаты элементами, измененными до этой метки времени ISO-8601.
Изменено после
 modifiedAfter string

Ограничить результаты элементами, измененными после этой метки времени ISO-8601.
Перед отправкой
 uploadedBefore string

Ограничить результаты элементами, отправленными до этой метки времени ISO-8601.
Отправлено после
 uploadedAfter string

Ограничить результаты элементами, отправленными после этой метки времени ISO-8601.
Тип
 type string

Какие типы элементов следует искать.
Запрошенный фрагмент кода
 snippetRequested boolean

Должны ли результаты поиска содержать фрагменты кода.
Сортировка по
 sortBy string

Поле, которое должно использоваться для сортировки.
Направление сортировки
 sortDirection string

Направление сортировки.
Поля запроса к файлам
 fileQueryFields string

Поиск файлов с помощью определенных полей.
Поля запроса к папке
 folderQueryFields string

Поиск папок с помощью определенных полей.
Оператор запроса
 queryOperator string

Выполните поиск всех слов или любого из слов.

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

Имя Путь Тип Описание
results
 results array of object
Имя файла
 results.name string
Путь к файлу
 results.path string
Тип MIME
 results.type string
Размер файла
 results.size integer
Обрезок
 results.snippet string
Фрагмент HTML
 results.snippet_html string
Идентификатор записи
 results.entry_id string
Идентификатор группы
 results.group_id string
Последнее изменение
 results.last_modified string
Отправлено по
 results.uploaded_by string
Отправлено по имени пользователя
 results.uploaded_by_username string
Количество версий
 results.num_versions integer
Папка Is
 results.is_folder boolean
Общее число
 total_count integer
Смещение
 offset integer
Численность
 count integer

Поиск версии 2

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

Найдите содержимое с расширенными возможностями поиска. https://developers.egnyte.com/api-docs/read/search-api#Search-v2

Параметры

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

Строка поиска, которую вы хотите найти.
Включение защиты искусственного интеллекта
 enableAISafeguards boolean

Включите оценку политик защиты ИИ. Защищенные записи будут отфильтрованы из результатов.
Смещение
 offset integer

0-й индекс запрашиваемой начальной записи.
Численность
 count integer

Количество записей на страницу.
Folder
 folder string

Ограничить результаты элементами в указанной папке и потомках.
Изменено до
 modifiedBefore integer

Ограничить результаты элементами, измененными до этой метки времени Unix в миллисекундах.
Изменено после
 modifiedAfter integer

Ограничить результаты элементами, измененными после этого метки времени Unix в миллисекундах.
Перед отправкой
 uploadedBefore integer

Ограничить результаты элементами, отправленными до этой метки времени Unix в миллисекундах.
Отправлено после
 uploadedAfter integer

Ограничить результаты элементами, отправленными после этого метки времени Unix в миллисекундах.
Тип
 type string

Какие типы элементов следует искать.
Запрошенный фрагмент кода
 snippetRequested boolean

Должны ли результаты поиска содержать фрагменты кода.
Сортировка по
 sortBy string

Поле, которое должно использоваться для сортировки.
Направление сортировки
 sortDirection string

Направление сортировки.
Поля запроса к файлам
 fileQueryFields array of string

Поиск файлов с помощью определенных полей.
Поля запроса к папке
 folderQueryFields array of string

Поиск папок с помощью определенных полей.
Оператор запроса
 queryOperator string

Выполните поиск всех слов или любого из слов.
Подробнее об этом (идентификаторы документов)
 mlt array of string

Массив идентификаторов документов, используемых в качестве ссылки для аналогичного поиска документов.
Более подобное (текст)
 mltt array of string

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

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

Имя Путь Тип Описание
results
 results array of object
Имя файла
 results.name string
Путь к файлу
 results.path string
Тип MIME
 results.type string
Размер файла
 results.size integer
Обрезок
 results.snippet string
Фрагмент HTML
 results.snippet_html string
Идентификатор записи
 results.entry_id string
Идентификатор группы
 results.group_id string
Последнее изменение
 results.last_modified string
Отправлено по
 results.uploaded_by string
Отправлено по имени пользователя
 results.uploaded_by_username string
Количество версий
 results.num_versions integer
Папка Is
 results.is_folder boolean
Настраиваемые свойства
 results.custom_properties array of object
Scope
 results.custom_properties.scope string
Namespace
 results.custom_properties.namespace string
Key
 results.custom_properties.key string
Ценность
 results.custom_properties.value string
Оценка релевантности
 results.score number
Общее число
 total_count integer
Численность
 count integer
Дополнительные результаты
 hasMore boolean

Поиск метаданных

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

Поиск элементов с определенным полем метаданных или значением. https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

Параметры

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

Какие типы элементов следует искать.
Имя пространства имен
 namespace True string

Имя пространства имен.
Ключ метаданных
 keyName True string

Имя ключа метаданных.
Имя пространства имен
 namespace True string

Имя пространства имен.
Ключ метаданных
 keyName True string

Имя ключа метаданных.
Значение метаданных
 value True string

Значение ключа метаданных.

Полное обновление группы

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

Перезапись всех атрибутов группы. https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

Параметры

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

Идентификатор созданной группы.
Показать имя
 displayName True string

Отображаемое имя группы.
Идентификатор пользователя
 value integer

Глобальный уникальный идентификатор члена группы.

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

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

Идентификатор созданной группы.
отображаемое имя
 displayName string

Отображаемое имя группы.
члены
 members array of object

Члены группы
Имя пользователя
 members.username string

Имя пользователя члена.
Идентификатор пользователя
 members.value number

Идентификатор пользователя члена.
отображаемое имя пользователя;
 members.display string

Отображаемое имя элемента.

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

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

Вывод списка всех папок проекта в домене. https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

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

response
array of ProjectItem

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

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

Получите список всех пользовательских пространств имен метаданных в домене. https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

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

response
array of NamespaceItem

Получение действующих разрешений

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

Получение эффективных разрешений для пользователя. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

Параметры

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

Полный путь к папке.
Имя пользователя
 username True string

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

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

Имя Путь Тип Описание
Разрешение
 permission string

Значение разрешения

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

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

Получение метаданных из папки с помощью идентификатора папки. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Параметры

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

Уникальный идентификатор папки в Egnyte.
Имя пространства имен
 namespace True string

Имя пространства имен.

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

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

Получение метаданных из файла с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

Параметры

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

Уникальный идентификатор файла в Egnyte.
Имя пространства имен
 namespace True string

Имя пространства имен.

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

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

Получение проекта с помощью идентификатора. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

Параметры

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

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

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

Тело
ProjectItem

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

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

Получение проекта на основе идентификатора корневой папки. https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

Параметры

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

Идентификатор корневой папки

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

response
array of ProjectItem

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

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

Перечислить все пользовательские ключи метаданных, созданные в заданном пространстве имен. https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.

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

Тело
NamespaceItem

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

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

Получение разрешений для папки. https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

Параметры

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

Полный путь к папке.

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

Имя Путь Тип Описание
Разрешения пользователя
 userPerms object

Сопоставление пользователя со значением разрешения.
Разрешения группы
 groupPerms object

Сопоставление имени группы со значением разрешения
Наследует разрешения
 inheritsPermissions boolean

Следует ли наследовать разрешения из родительской папки.
Сохранение родительских разрешений
 keepParentPermissions boolean

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

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

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

Получение сведений о группе с помощью идентификатора. https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

Параметры

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

Идентификатор группы.

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

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

Глобальный уникальный идентификатор группы.
Имя группы
 displayName string

Имя группы.
члены
 members array of object

Члены группы
Идентификатор группы
 members.username string

Имя пользователя члена группы
Идентификатор пользователя
 members.value number

Глобальный уникальный идентификатор члена группы.
отображаемое имя пользователя;
 members.display string

Отображаемое имя члена группы.

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

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

Получение сведений о папке с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Параметры

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

Уникальный идентификатор папки в Egnyte.

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

Тело
FolderInfoResponse

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

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

Получение сведений о папке с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Параметры

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

Уникальный путь к папке в Egnyte.

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

Тело
FolderInfoResponse

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

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

Извлеките сведения о пользователе по идентификатору. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

Параметры

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

Идентификатор пользователя

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

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

Тело
UserInfoResponse

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

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

Получение сведений о файле с помощью идентификатора файла. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Параметры

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

Уникальный идентификатор файла в Egnyte.

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

Тело
FileInfoResponse

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

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

Получение сведений о файле с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

Параметры

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

Уникальный путь к файлу в Egnyte.

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

Тело
FileInfoResponse

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

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

Извлекает содержимое файла из Egnyte с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Параметры

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

Уникальный идентификатор файла в Egnyte.
Включение защиты искусственного интеллекта
 enableAISafeguards boolean

Включите оценку политик защиты ИИ. Защищенное содержимое файла будет заменено заполнителем.

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

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

Извлекает содержимое файла из Egnyte с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

Параметры

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

Уникальный путь к файлу в Egnyte.
Включение защиты искусственного интеллекта
 enableAISafeguards boolean

Включите оценку политик защиты ИИ. Защищенное содержимое файла будет заменено заполнителем.

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

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

Получение списка групп. https://developers.egnyte.com/api-docs/read/group-management#List-Groups

Параметры

Имя Ключ Обязательно Тип Описание
Начальный индекс
 startIndex integer

1-й индекс запрашиваемой начальной записи (целочисленное ≥ 1).
Численность
 count integer

Количество записей на страницу (минимум 1, максимум 100)
Filter
 filter string

Позволяет запрашивать подмножество групп. Эти термины не учитывает регистр

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

Имя Путь Тип Описание
Общий объем результатов
 totalResults integer

Общее количество результатов, соответствующих запросу.
Элементы на странице
 itemsPerPage integer

Количество возвращенных результатов.
Начальный индекс
 startIndex integer

1-й индекс первого результата в текущем наборе результатов.
resources
 resources array of object
Идентификатор группы
 resources.id string

Глобальный уникальный идентификатор группы.
Имя группы
 resources.displayName string

Имя группы.

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

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

Получение сведений о пользователях. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

Параметры

Имя Ключ Обязательно Тип Описание
Начальный индекс
 startIndex integer

1-й индекс первого результата поиска.
Численность
 count integer

Указывает требуемое максимальное количество результатов поиска на страницу.
Filter
 filter string

Позволяет запрашивать подмножество пользователей. См. документацию в разделе "Сведения".

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

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

Тело
UserListResponse

Пометить папку как проект

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

Помечайте существующую папку как проект. https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

Параметры

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

FolderId корневой папки проекта
Имя
 name True string

Имя проекта
Description
 description string

Описание папки
Состояние
 status True string

Состояние проекта
Дата начала (например, 2023-12-31T23:59:59)
 startDate date-time

Дата начала проекта.
Дата завершения (например, 2023-12-31T23:59:59)
 completionDate date-time

Дата завершения проекта.

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

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

Идентификатор элемента

Разблокировка файла по идентификатору

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

Разблокируйте файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Параметры

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

Уникальный идентификатор файла в Egnyte.
Маркер блокировки
 lock_token True string

Текущий маркер блокировки для файла.

Разблокировка файла по пути

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

Разблокируйте файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

Параметры

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

Уникальный путь к файлу в Egnyte.
Маркер блокировки
 lock_token True string

Текущий маркер блокировки для файла.

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

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

Создайте группу в Egnyte. https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

Параметры

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

Отображаемое имя группы.
Идентификатор пользователя
 value string

Глобальный уникальный идентификатор члена группы.

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

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

Идентификатор созданной группы.
отображаемое имя
 displayName string

Отображаемое имя группы.
члены
 members array of object

Члены группы
Имя пользователя
 members.username string

Имя пользователя члена.
Идентификатор пользователя
 members.value number

Идентификатор пользователя члена.
отображаемое имя пользователя;
 members.display string

Отображаемое имя элемента.

Создание ключа метаданных

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

Добавьте ключ метаданных в существующее пространство имен. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.
Имя ключа
 key True string

Имя создаваемого ключа.
Тип (для перечисления: обязательный параметр данных)
 type True string

Указывает тип данных для ключа.
Показать имя
 displayName string

Имя для идентификации поля в пользовательском интерфейсе.
Priority
 priority number

Указывает приоритет ключа (ключи с более высоким приоритетом будут отображаться сначала).
Текст справки
 helpText True string

Описание поля метаданных для релевантности поиска и обработки ИИ (20–200 символов).
Данные
 data array of string

Для ключа типа перечисления указывает перечисленные значения.

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

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

Создайте пользователя в Egnyte. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

Параметры

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

Имя пользователя Egnyte для пользователя. Должен начинаться с буквы или цифры.
Адрес электронной почты
 email True string

Адрес электронной почты пользователя (например, admin@acme.com).
Личное имя
 givenName True string

Имя пользователя.
Фамилия
 familyName True string

Фамилия пользователя.
Active
 active True boolean

Является ли пользователь активным или неактивным.
Тип пользователя
 userType True string

Тип пользователя.
Тип проверки подлинности
 authType True string

Тип проверки подлинности для пользователя.
Внешний идентификатор
 externalId string

Неизменяемый уникальный идентификатор, предоставленный потребителем API.
Отправка приглашения
 sendInvite boolean

Если задано значение true при создании пользователя, будет отправлено сообщение электронной почты приглашения (если пользователь создан в активном состоянии).
Учетная запись службы
 isServiceAccount boolean

Если задано значение true при создании пользователя, пользователь будет создан как учетная запись службы.
Language
 language string

Параметр "language" принимается только в том случае, если языковой пакет включен для домена.
Role
 role string

Роль, назначенная пользователю. Применимо только для Power Users.
Идентификатор пользователя поставщика удостоверений
 idpUserId string

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

Не указывайте, не прошел ли пользователь проверку подлинности AD. Используется для привязки дочерних политик проверки подлинности к пользователю при использовании проверки подлинности Active Directory в настройке нескольких доменов.

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

Имя Путь Тип Описание
Идентификатор пользователя
 id integer

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

Имя пользователя Egnyte для пользователя.
Внешний идентификатор
 externalId string

Неизменяемый уникальный идентификатор, предоставленный потребителем API.
Адрес электронной почты
 email string

Адрес электронной почты пользователя.
Ожидается изменение электронной почты
 emailChangePending boolean

Ожидается ли изменение электронной почты.
Личное имя
 name.givenName string

Имя пользователя.
Фамилия
 name.familyName string

Фамилия пользователя.
Отформатированный имя
 name.formatted string

Отформатированное полное имя пользователя.
Active
 active boolean

Является ли пользователь активным.
Заблокировано
 locked boolean

Заблокирована ли учетная запись пользователя.
Тип проверки подлинности
 authType string

Тип проверки подлинности для пользователя.
Тип пользователя
 userType string

Тип пользователя.
Идентификатор пользователя поставщика удостоверений
 idpUserId string

Способ идентификации пользователя в ответе SAML от поставщика удостоверений единого входа.
Основное имя пользователя
 userPrincipalName string

Используется для привязки дочерних политик проверки подлинности к пользователю при использовании проверки подлинности Active Directory.
Role
 role string

Роль, назначенная пользователю. Применимо только для Power Users.
Language
 language string

Предпочтение языка для пользователя.
Дата создания
 createdDate date-time

Дата и время создания пользователя.
Дата последнего изменения
 lastModificationDate date-time

Дата и время последнего изменения.
Дата последнего активного действия
 lastActiveDate date-time

Дата и время последнего действия.
Дата окончания срока действия
 expiryDate date-time

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

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

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

Создайте проект из шаблона папки проекта. https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

Параметры

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

Идентификатор папки родительской папки, в которой будет создана папка проекта
Идентификатор папки шаблона
 templateFolderId True string

Идентификатор папки шаблона папки проекта
Имя папки
 folderName True string

Имя новой папки, которая будет создана
Имя
 name True string

Имя проекта
Description
 description string

Описание папки
Идентификатор проекта
 projectId string

Пользовательский идентификатор проекта
Имя клиента
 customerName string

Клиент, связанный с проектом
Состояние
 status True string

Состояние проекта
Дата начала (например, 2023-12-31T23:59:59)
 startDate date-time

Дата начала проекта.
Дата завершения (например, 2023-12-31T23:59:59)
 completionDate date-time

Дата завершения проекта.
Адрес улицы 1
 streetAddress1 string

Первая строка адреса улицы
Адрес улицы 2
 streetAddress2 string

Вторая строка адреса
Город
 city string

Город
Штат или провинция
 state string

Штат или провинция
Страна
 country string

Страна
Почтовый индекс или почтовый индекс
 postalCode string

Почтовый индекс или почтовый индекс

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

Имя Путь Тип Описание
groupsCreated
 groupsCreated array of object
Идентификатор проекта
 groupsCreated.id string

Код проекта
Имя проекта
 groupsCreated.name string

Имя проекта

Создание пространства имен

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

Создайте пространство имен в Egnyte. https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

Параметры

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

Имя пространства имен
Показать имя
 displayName string

Имя для идентификации пространства имен в пользовательском интерфейсе
Scope
 scope True string

Кто может видеть и изменять пространство имен
Имя ключа
 name True string

Имя ключа
Тип
 type True string

Указывает тип данных для ключа
Отображаемое имя
 displayName string

Имя для идентификации поля в пользовательском интерфейсе
Текст справки
 helpText True string

Описание поля метаданных для релевантности поиска и обработки ИИ (20–200 символов)
Priority
 priority number

Указывает приоритет ключа (ключи с более высоким приоритетом будут отображаться сначала
Данные (для типа перечисления)
 data array of string

Для ключа типа перечисления указывает перечисленные значения

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

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

Создайте папку в Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

Параметры

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

Полный путь к новой папке.

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

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

Полный путь к созданной папке
Идентификатор папки
 folder_id string

Уникальный идентификатор созданной папки

Создать ссылку

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

Создайте ссылку. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

Параметры

Имя Ключ Обязательно Тип Описание
Путь
 path True string

Абсолютный путь к целевому файлу или папке.
Тип
 type True string

Это определяет тип создаваемой ссылки.
Доступность
 accessibility string

Определяет, кем доступна ссылка. Требуется, за исключением ссылок отправки или если значение "useDefaultSettings" имеет значение true.
Использование параметров по умолчанию
 useDefaultSettings True boolean

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

Если задано значение true, ссылка будет отправлена по электронной почте Egnyte.
Получатели
 recipients array of string

Список адресов электронной почты получателей ссылки. Требуется только в том случае, если значение "Отправить сообщение электронной почты" имеет значение true.
Сообщение (применяется только в том случае, если значение "Отправить сообщение электронной почты" имеет значение true.)
 message string

Личное сообщение, которое будет отправлено по ссылке.
Скопируйте меня (применяется только в том случае, если значение "Отправить сообщение электронной почты" имеет значение true)
 copy_me boolean

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

Если задано значение true, создатель ссылки будет получать уведомления по электронной почте при доступе к ссылке.
Ссылка на текущую (применимо только для ссылок на файлы.)
 link_to_current boolean

Если задано значение true, ссылка всегда будет ссылаться на текущую версию файла.
Дата окончания срока действия (например, 2023-12-31)
 expiry_date string

Дата окончания срока действия ссылки. Если задано значение "Срок действия щелчков" не может быть задано.
Щелчки по истечении срока действия
 expiry_clicks number

Число щелчков по ссылке допустимо. Если задано значение "Дата окончания срока действия", не удается задать
Добавление имени файла (только ссылки на файлы, а не ссылки на папки)
 add_file_name boolean

Если значение true, имя файла будет добавлено в конец ссылки.
Пароль (если параметр "специальные возможности" имеет значение "password")
 password string

Если он не указан, система автоматически создаст пароль.
Защита
 protection string

Если задано значение "Preview", он создаст ссылку только для предварительной версии.
Папка для каждого получателя (применяется только для отправки ссылок.)
 folder_per_recipient boolean

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

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

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

Массив, содержащий полные сведения json для всех ссылок для домена, которые этот пользователь может видеть в любом указанном диапазоне.
Идентификатор
 links.id string

Идентификатор ссылки
URL-адрес
 links.url string

Полный URL-адрес ссылки
Получатели
 links.recipients array of string

Массив допустимых адресов электронной почты, на которые была отправлена ссылка.
Путь
 path string

Абсолютный путь к целевому ресурсу либо файлу, либо папке.
Тип
 type string

Тип ссылки, файла, папки или отправки
Доступность
 accessibility string

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

Логическое значение о том, будет ли создатель ссылки получать уведомления по электронной почте при доступе к ссылке.
Ссылка на текущую
 link_to_current boolean

Логическое значение, указывающее, будет ли ссылка всегда ссылаться на текущую версию файла. Применимо только для ссылок на файлы.
Дата окончания срока действия
 expiry_date string

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

Дата и время создания ссылки
Кем создано:
 created_by string

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

Создать файл

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

Отправляет файл в Egnyte. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

Параметры

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

Имя файла, создаваемого в Egnyte.
Путь к папке
 Path True string

Путь к папке для отправки файла в Egnyte.
Содержимое файла
 body True binary

Содержимое файла для отправки в Egnyte.

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

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

Идентификатор текущей версии файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.
Путь к файлу
 path string

Полный путь отправленного файла.

Список всех ссылок

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

Выводит список всех ссылок, кроме удаленных ссылок. Обратите внимание, что если пользователь, выполняющий этот метод, не является администратором, будут перечислены только ссылки, созданные пользователем. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

Параметры

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

Список ссылок на файл или папку, указанную по полному пути.
Имя пользователя
 username string

Список ссылок, созданных этим пользователем.
Создано раньше
 createdBefore string

Список ссылок, созданных до заданной даты (ISO-8601 или YYY-MM-DD).
Создано после
 createdAfter string

Список ссылок, созданных после заданной даты (ISO-8601 или YYY-MM-DD).
Тип
 type string

Фильтруйте только элементы "file" или "folder".
Доступность
 accessibility string

Выбор типа специальных возможностей
Смещение
 offset string

0-й индекс запрашиваемой начальной записи.
Count (По умолчанию возвращается 500 записей)
 count string

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

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

Имя Путь Тип Описание
Идентификаторы
 ids array of string

Массив, содержащий идентификаторы всех ссылок для вашего домена, который может видеть этот пользователь.
Смещение
 offset number

0-й индекс запрашиваемой начальной записи.
Численность
 count number

Количество возвращаемых элементов. Если это поле не указано, значение счетчика будет равно 0.
Общее число
 total_count number

Количество ссылок, видимых пользователю в домене.

Список всех ссылок версии 2

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

Выводит список всех ссылок. Обратите внимание, что если пользователь, выполняющий этот метод, не является администратором, будут перечислены только ссылки, созданные пользователем. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

Параметры

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

Список ссылок на файл или папку, указанную по полному пути.
Имя пользователя
 username string

Список ссылок, созданных этим пользователем.
Создано раньше
 createdBefore string

Список ссылок, созданных до заданной даты (ISO-8601 или YYY-MM-DD).
Создано после
 createdAfter string

Список ссылок, созданных после заданной даты (ISO-8601 или YYY-MM-DD).
Тип
 type string

Фильтруйте только элементы "file" или "folder".
Доступность
 accessibility string

Выбор типа специальных возможностей
Смещение
 offset string

0-й индекс запрашиваемой начальной записи.
Count (По умолчанию возвращается 500 записей)
 count string

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

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

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

Массив, содержащий полные сведения json для всех ссылок для домена, которые этот пользователь может видеть в любом указанном диапазоне.
Путь
 links.path string

Абсолютный путь к целевому ресурсу либо файлу, либо папке.
Тип
 links.type string

Тип ссылки, файла, папки или отправки
Доступность
 links.accessibility string

Доступ к ссылке осуществляется одним из всех пользователей, паролем, доменом или получателями.
Защита
 links.protection string

Если ссылка "PREVIEW" для ссылки на файл (или папку) доступна только для предварительной версии, в противном случае используется значение NONE.
Получатели
 links.recipients array of string

Массив допустимых адресов электронной почты, на которые была отправлена ссылка.
Уведомить
 links.notify boolean

Логическое значение о том, будет ли создатель ссылки получать уведомления по электронной почте при доступе к ссылке.
URL-адрес
 links.url string

Полный URL-адрес ссылки
Идентификатор
 links.id string

Идентификатор ссылки
Ссылка на текущую
 links.link_to_current boolean

Логическое значение, указывающее, будет ли ссылка всегда ссылаться на текущую версию файла. Применимо только для ссылок на файлы.
Дата создания
 links.creation_date string

Дата и время создания ссылки
Кем создано:
 links.created_by string

Имя пользователя, создавшего ссылку
Идентификатор ресурса
 links.resource_id string

Идентификатор связанного ресурса, идентификатор группы, если он является ссылкой на файл, или идентификатор папки, если это папка или ссылка на отправку
Щелчки по истечении срока действия
 links.expiry_clicks number

Количество щелчков слева на ссылке до истечения срока действия. Это поле отображается только в том случае, если срок действия ссылки истекает с помощью щелчков.
Последний доступ
 links.last_accessed string

Дата и время последнего доступа к ссылке. Это поле отображается только в том случае, если ссылка была доступна по крайней мере один раз
Дата окончания срока действия
 links.expiry_date string

Дата и время истечения срока действия ссылки. Это поле отображается только в том случае, если ссылка истекает по дате
Численность
 count number

Количество ссылок, видимых пользователю в домене, возвращенном

Удаление группы

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

Удаление группы по идентификатору. https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

Параметры

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

Идентификатор группы.

Удаление ключа метаданных

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

Удалите ключ метаданных из существующего пространства имен. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.
Имя
 key True string

Имя ключа, который вы удаляете.
Принудительное удаление
 force boolean

Удалите, даже если используется ключ метаданных.

Удаление папки по идентификатору

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

Удалите папку с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Параметры

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

Уникальный идентификатор папки для удаления из Egnyte.

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

Имя Путь Тип Описание
Путь к родительской папке
 parent_folder_path string

Путь к родительской папке для удаленной папки.

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

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

Удалите папку с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Параметры

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

Путь к папке в Egnyte, включая имя целевой папки для удаления.

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

Имя Путь Тип Описание
Путь к родительской папке
 parent_folder_path string

Путь к родительской папке для удаленной папки.

Удаление пользователя по идентификатору

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

Удаление пользователя из Egnyte. Подробнее: https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

Параметры

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

Идентификатор пользователя для удаления

Удаление проекта по идентификатору

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

Удалите проект на основе его идентификатора. https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

Параметры

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

Идентификатор удаленного проекта

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

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

Удалите указанное пространство имен. https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

Параметры

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

Уникальный идентификатор пространства имен в Egnyte.
Принудительное удаление
 force boolean

Удаление, даже если используется пространство имен

Удаление файла по идентификатору

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

Удалите файл с помощью идентификатора. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Параметры

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

Уникальный идентификатор файла для удаления из Egnyte.

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

Имя Путь Тип Описание
Путь к родительской папке
 parent_folder_path string

Путь к родительской папке для удаленного файла.

Удаление файла по пути

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

Удалите файл с помощью пути. https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

Параметры

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

Путь к файлу в Egnyte, включая имя целевого файла.

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

Имя Путь Тип Описание
Путь к родительской папке
 parent_folder_path string

Путь к родительской папке для удаленного файла

Удалить ссылку

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

Удаление ссылки. https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

Параметры

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

LinkId

Частичное обновление группы

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

Обновите определенные атрибуты группы. https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

Параметры

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

Идентификатор созданной группы.
Показать имя
 displayName string

Отображаемое имя группы.
Идентификатор пользователя
 value integer

Глобальный уникальный идентификатор члена группы.
Операция
 operation string

Действие, которое вы хотите выполнить в группе.

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

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

Идентификатор созданной группы.
отображаемое имя
 displayName string

Отображаемое имя группы.
члены
 members array of object

Члены группы
Имя пользователя
 members.username string

Имя пользователя члена.
Идентификатор пользователя
 members.value number

Идентификатор пользователя члена.
отображаемое имя пользователя;
 members.display string

Отображаемое имя элемента.

Триггеры

Если папка не отмечена как проект

Эта операция активирует поток, если папка не отмечена как проект
Если рабочий процесс типа утверждения отклонен

Эта операция активирует поток при отклонении рабочего процесса типа утверждения
После завершения рабочего процесса

Эта операция активирует поток при завершении рабочего процесса.
При блокировке файла

Эта операция активирует поток при блокировке файла
При изменении метаданных файла или папки

Эта операция активирует поток при изменении метаданных файла или папки
При изменении разрешения файла или папки

Эта операция активирует поток при изменении разрешений файла или папки
При копировании папки

Эта операция активирует поток при копировании вложенной папки в папку.
При копировании файла

Эта операция активирует поток при копировании файла в папку.
При обновлении группы

Эта операция активирует поток при обновлении группы
При обновлении проекта

Эта операция активирует поток при обновлении проекта
При обновлении файла

Эта операция активирует поток при обновлении файла в определенной папке
При переименовании папки

Эта операция активирует поток при переименовании вложенной папки в папке.
При переименовании файла

Эта операция активирует поток при переименовании файла в папке.
При перемещении папки

Эта операция активирует поток при перемещении вложенной папки в папку.
При перемещении файла

Эта операция активирует поток при перемещении файла в папку.
При разблокировке файла

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

Эта операция активирует поток при создании группы
При создании папки

Эта операция активирует поток при создании вложенной папки в папке.
При создании папки проекта

Эта операция активирует поток при создании папки проекта или в том случае, если существующая папка помечена как папка проекта
При создании рабочего процесса

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

Эта операция активирует поток при создании ссылки общего ресурса
При создании файла (веб-перехватчик)

Эта операция активирует поток при создании файла в определенной папке
При создании файла (опрос)

Эта операция активирует поток при создании нового файла в папке.
При удалении группы

Эта операция активирует поток при удалении группы
При удалении папки

Эта операция активирует поток при удалении вложенной папки в папке.
При удалении ссылки на общую папку

Эта операция активирует поток при удалении ссылки общего ресурса
При удалении файла

Эта операция активирует поток при удалении файла в папке.
При утверждении рабочего процесса типа утверждения

Эта операция активирует поток при утверждении рабочего процесса типа утверждения

Если папка не отмечена как проект

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

Эта операция активирует поток, если папка не отмечена как проект

Параметры

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

Путь к целевой папке.

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

Тело
FolderProjectCommon

Если рабочий процесс типа утверждения отклонен

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

Эта операция активирует поток при отклонении рабочего процесса типа утверждения

Параметры

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

Путь к целевой папке.

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

Тело
WorkflowStepResponse

После завершения рабочего процесса

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

Эта операция активирует поток при завершении рабочего процесса.

Параметры

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

Путь к целевой папке.

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

Имя Путь Тип Описание
Идентификатор рабочего процесса
 workflow.id string
Имя рабочего процесса
 workflow.name string
Идентификатор отображения рабочего процесса
 workflow.displayId number
Тип рабочего процесса
 workflow.type string
Идентификатор шаблона рабочего процесса
 workflow.templateId string
Состояние действия рабочего процесса
 workflow.actionStatus string
Первый тип сущности
 firstEntity.type string
Путь к первой сущности
 firstEntity.filePath string
Идентификатор записи первой сущности
 firstEntity.entryID string
Идентификатор первой группы сущностей
 firstEntity.groupID string
Код состояния завершения
 completionStatusCode string
Общее количество шагов
 totalNumberOfSteps number
Дата завершения
 completionDate number

При блокировке файла

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

Эта операция активирует поток при блокировке файла

Параметры

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

Путь к целевому файлу или папке.

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

Тело
FileLockWebhookResponse

При изменении метаданных файла или папки

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

Эта операция активирует поток при изменении метаданных файла или папки

Параметры

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

Путь к целевой папке.

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

Имя Путь Тип Описание
Целевой путь
 targetPath string
Идентификатор целевой группы
 targetGroupId string
Namespace
 namespace string
Key
 key string
Действие
 action string

При изменении разрешения файла или папки

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

Эта операция активирует поток при изменении разрешений файла или папки

Параметры

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

Путь к целевой папке.

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

Имя Путь Тип Описание
Назначенное лицо
 assignee string
Идентификатор назначаемого получателя
 assigneeId number
Назначатель
 assigner string
Идентификатор назначателя
 assignerId number
Путь к папке
 folderPath string
Новая привилегия
 newPrivilege string
Старые привилегии
 oldPrivilege string
Имя группы
 groupName string

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

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

Эта операция активирует поток при копировании вложенной папки в папку.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к папке
 data.target_path string

Полный путь к папке
Путь к исходной папке
 data.source_path string

Полный исходный путь к папке
Папка Is
 data.is_folder boolean

Является ли ресурс папкой (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте

При копировании файла

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

Эта операция активирует поток при копировании файла в папку.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к файлу
 data.target_path string

Полный путь к файлу.
Идентификатор версии
 data.target_id string

Идентификатор конкретной версии файла.
Идентификатор файла
 data.target_group_id string

Идентификатор для ссылки на файл в целом.
Путь к исходному файлу
 data.source_path string

Полный исходный путь к файлу.
Идентификатор версии исходного файла
 data.source_id string

Идентификатор исходной версии файла.
Идентификатор исходного файла
 data.source_group_id string

Исходный идентификатор файла для ссылки на файл в целом.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте.

При обновлении группы

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

Эта операция активирует поток при обновлении группы

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

Имя Путь Тип Описание
Идентификатор пользователя
 user.id integer

Уникальный идентификатор пользователя.
Полное имя
 user.fullName string

Полное имя пользователя.
Имя пользователя
 user.userName string

Имя пользователя.
Электронная почта пользователя
 user.email string

Адрес электронной почты пользователя.
Идентификатор пользователя
 owner.id integer

Уникальный идентификатор пользователя.
Полное имя
 owner.fullName string

Полное имя пользователя.
Имя пользователя
 owner.userName string

Имя пользователя.
Электронная почта пользователя
 owner.email string

Адрес электронной почты пользователя.
Имя группы
 groupName string

Имя группы.
Идентификатор группы
 groupId string

Уникальный идентификатор группы.
Действие
 action string

Конкретное действие, активировающее обновление группы.
Members
 members array of GroupUser

Члены группы.

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

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

Эта операция активирует поток при обновлении проекта

Параметры

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

Путь к целевой папке.

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

Имя Путь Тип Описание
projectId
 projectId string
projectRootFolderId
 projectRootFolderId string
Имя проекта
 name string
Расположение проекта
 location string
Состояние проекта
 status string

Состояние проекта (ОЖИДАНИЕ, ВРЕМЯ ВЫПОЛНЕНИЯ, ON-HOLD, ЗАВЕРШЕНО, ОТМЕНЕНО)

При обновлении файла

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

Эта операция активирует поток при обновлении файла в определенной папке

Параметры

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

Путь к целевому файлу или папке.

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

Имя Путь Тип Описание
Идентификатор записи файла
 targetEntryId string
Идентификатор файла
 targetGroupId string
Путь к файлу
 targetPath string

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

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

Эта операция активирует поток при переименовании вложенной папки в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к папке
 data.target_path string

Полный путь к папке.
Путь к исходной папке
 data.source_path string

Полный исходный путь к папке.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте

При переименовании файла

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

Эта операция активирует поток при переименовании файла в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к файлу
 data.target_path string

Полный путь к переименованию файла
Идентификатор версии
 data.target_id string

Идентификатор конкретной версии файла.
Идентификатор файла
 data.target_group_id string

Идентификатор для ссылки на файл в целом.
Путь к исходному файлу
 data.source_path string

Полный исходный путь к файлу.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте

При перемещении папки

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

Эта операция активирует поток при перемещении вложенной папки в папку.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к папке
 data.target_path string

Полный путь к папке.
Путь к исходной папке
 data.source_path string

Полный исходный путь к папке.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте

При перемещении файла

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

Эта операция активирует поток при перемещении файла в папку.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор отдельного события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к файлу
 data.target_path string

Полный путь к файлу.
Идентификатор версии
 data.target_id string

Идентификатор конкретной версии файла.
Идентификатор файла
 data.target_group_id string

Идентификатор для ссылки на файл в целом.
Путь к исходному файлу
 data.source_path string

Полный исходный путь к файлу.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте.

При разблокировке файла

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

Эта операция активирует поток при разблокировке файла

Параметры

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

Путь к целевому файлу или папке.

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

Тело
FileLockWebhookResponse

При создании группы

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

Эта операция активирует поток при создании группы

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

Имя Путь Тип Описание
Идентификатор пользователя
 user.id integer

Уникальный идентификатор пользователя.
Полное имя
 user.fullName string

Полное имя пользователя.
Имя пользователя
 user.userName string

Имя пользователя.
Электронная почта пользователя
 user.email string

Адрес электронной почты пользователя.
Идентификатор пользователя
 owner.id integer

Уникальный идентификатор пользователя.
Полное имя
 owner.fullName string

Полное имя пользователя.
Имя пользователя
 owner.userName string

Имя пользователя.
Электронная почта пользователя
 owner.email string

Адрес электронной почты пользователя.
Имя группы
 groupName string

Имя группы.
Идентификатор группы
 groupId string

Уникальный идентификатор группы.
Members
 members array of GroupUser

Члены группы.

При создании папки

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

Эта операция активирует поток при создании вложенной папки в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к папке
 data.target_path string

Полный путь к папке.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте.

При создании папки проекта

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

Эта операция активирует поток при создании папки проекта или в том случае, если существующая папка помечена как папка проекта

Параметры

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

Путь к целевой папке.

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

Тело
FolderProjectCommon

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

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

Эта операция активирует поток при создании рабочего процесса

Параметры

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

Путь к целевой папке.

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

Имя Путь Тип Описание
Идентификатор рабочего процесса
 workflow.id string
Имя рабочего процесса
 workflow.name string
Идентификатор отображения рабочего процесса
 workflow.displayId number
Тип рабочего процесса
 workflow.type string
Идентификатор шаблона рабочего процесса
 workflow.templateId string
Состояние действия рабочего процесса
 workflow.actionStatus string
Первый тип сущности
 firstEntity.type string
Путь к первой сущности
 firstEntity.filePath string
Идентификатор записи первой сущности
 firstEntity.entryID string
Идентификатор первой группы сущностей
 firstEntity.groupID string
Определение JSON
 definitionJson string

При создании ссылки общего ресурса

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

Эта операция активирует поток при создании ссылки общего ресурса

Параметры

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

Путь к целевой папке.

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

Тело
LinkWebhookResponse

При создании файла (веб-перехватчик)

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

Эта операция активирует поток при создании файла в определенной папке

Параметры

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

Путь к целевому файлу или папке.

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

Имя Путь Тип Описание
Идентификатор записи файла
 targetEntryId string
Идентификатор файла
 targetGroupId string
Путь к файлу
 targetPath string
URL-адрес ссылки отправки
 uploadLinkUrl string

Доступно только в том случае, если файл был отправлен по ссылке отправки

При создании файла (опрос)

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

Эта операция активирует поток при создании нового файла в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к файлу
 data.target_path string

Полный путь к файлу.
Идентификатор версии
 data.target_id string

Идентификатор конкретной версии файла.
Идентификатор файла
 data.target_group_id string

Идентификатор для ссылки на файл в целом.
Папка Is
 data.is_folder boolean

Является ли ресурс папкой (True или False).
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.
Сведения об объекте
 object_detail string

Сведения об объекте.

При удалении группы

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

Эта операция активирует поток при удалении группы

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

Имя Путь Тип Описание
Идентификатор пользователя
 user.id integer

Уникальный идентификатор пользователя.
Полное имя
 user.fullName string

Полное имя пользователя.
Имя пользователя
 user.userName string

Имя пользователя.
Электронная почта пользователя
 user.email string

Адрес электронной почты пользователя.
Имя группы
 groupName string

Имя группы.
Идентификатор группы
 groupId string

Уникальный идентификатор группы.

При удалении папки

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

Эта операция активирует поток при удалении вложенной папки в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к папке
 data.target_path string

Полный путь к удаленной папке.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.

При удалении ссылки на общую папку

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

Эта операция активирует поток при удалении ссылки общего ресурса

Параметры

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

Путь к целевой папке.

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

Тело
LinkWebhookResponse

При удалении файла

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

Эта операция активирует поток при удалении файла в папке.

Параметры

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

Путь к целевой папке.

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

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

Идентификатор события.
Отметка времени
 timestamp string

Метка времени в формате ISO-8601 для записи этого события.
Идентификатор пользователя
 actor integer

Числовые идентификаторы пользователя, выполнившего действие.
Действие
 action string

Действие, связанное с этим событием.
Путь к версии
 data.target_path string

Полный путь к определенной версии файла.
Идентификатор файла
 data.target_group_id string

Идентификатор для ссылки на файл в целом.
Папка Is
 data.is_folder boolean

Указывает, является ли ресурс папкой. (True или False)
Источник действия
 action_source string

Источник события. Например, WebUI, Mobile и т. д.

При утверждении рабочего процесса типа утверждения

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

Эта операция активирует поток при утверждении рабочего процесса типа утверждения

Параметры

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

Путь к целевой папке.

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

Тело
WorkflowStepResponse

Определения

GroupUser

Имя Путь Тип Описание
Идентификатор пользователя
 id integer

Уникальный идентификатор пользователя.
Полное имя
 fullName string

Полное имя пользователя.
Имя пользователя
 userName string

Имя пользователя.
Электронная почта пользователя
 email string

Адрес электронной почты пользователя.

LinkWebhookResponse

Имя Путь Тип Описание
Исходный путь
 sourcePath string
Идентификатор ссылки
 linkId string
Тип ссылки
 linkType string

Папка или файл
URL-адрес ссылки
 linkURL string

FileInfoResponse

Имя Путь Тип Описание
Контрольная сумма
 checksum string

Контрольной суммы текущей версии файла, используемой для определения изменений файлов.
Size
 size integer

Размер файла в байтах.
Путь к файлу
 path string

Полный путь к файлу.
Имя
 name string

Имя файла.
Заблокировано
 locked boolean

Состояние блокировки файла.
Папка Is
 is_folder boolean

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

Идентификатор текущей версии файла.
Идентификатор файла
 group_id string

Идентификатор для ссылки на файл в целом.
Идентификатор родительской папки
 parent_id string

Идентификатор родительской папки, запрошенной.
Последнее изменение
 last_modified string

Время последнего изменения текущей версии файла.
Отправлено
 uploaded_by string

Имя пользователя, отправив ей текущую версию.
Загруженная метка времени
 uploaded integer

Время отправки текущей версии файла.
Количество версий
 num_versions integer

Общее количество версий, связанных с определенным путем к файлу.
versions
 versions array of object

Versions
Папка Is (версия)
 versions.is_folder boolean

Указывает, является ли ресурс папкой. Истина или Ложь
Идентификатор версии
 versions.entry_id string

Идентификатор конкретной версии файла.
Контрольная сумма (версия)
 versions.checksum string

Контрольное значение версии файла, используемой для определения изменений файлов.
Последнее изменение (версия)
 versions.last_modified string

Время последнего изменения конкретной версии файла.
Отправлено (версия)
 versions.uploaded_by string

Имя пользователя, отправив версию.
Загруженная метка времени (версия)
 versions.uploaded integer

Время отправки определенной версии файла.
Размер (версия)
 versions.size integer

Размер файла в байтах для конкретной версии.

UserInfoResponse

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

Имя Путь Тип Описание
Идентификатор пользователя
 id integer

Идентификатор пользователя
Имя пользователя
 userName string

Имя пользователя
Внешний идентификатор
 externalId string

Внешний идентификатор
Адрес электронной почты
 email string

Электронная почта пользователя
Фамилия
 name.familyName string

Имя семейства пользователей (фамилия)
Личное имя
 name.givenName string

Имя пользователя (имя)
Active
 active boolean

Активна ли учетная запись пользователя
Дата создания
 createdDate string

Пользователь даты был создан
Дата последнего изменения
 lastModificationDate string

Пользователь последней даты был изменен
Дата последнего активного действия
 lastActiveDate string

Пользователь последней даты был активным
Заблокировано
 locked boolean

Пользователь заблокирован
Language
 language string

Параметр "language" принимается только в том случае, если языковой пакет включен для домена.
Тип проверки подлинности
 authType string

Тип проверки подлинности для пользователя.
Тип пользователя
 userType string

Тип пользователя.
Role
 role string

Роль, назначенная пользователю. Применимо только для Power Users.
Идентификатор пользователя поставщика удостоверений
 idpUserId string

Идентификатор пользователя поставщика удостоверений
Учетная запись службы
 isServiceAccount boolean

Учетная запись, используемая в качестве учетной записи службы
Удаление по истечении срока действия
 deleteOnExpiry string

Будет ли учетная запись удалена после истечения срока действия
Ожидается изменение электронной почты
 emailChangePending boolean

Ожидается ли изменение электронной почты пользователя
Дата окончания срока действия
 expiryDate string

Истечение срока действия учетной записи
Основное имя пользователя
 userPrincipalName string
groups
 groups array of object
Показать имя
 groups.displayName string

Имя группы
Идентификатор группы
 groups.value string

Идентификатор группы

UserListResponse

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

Имя Путь Тип Описание
Общий объем результатов
 totalResults integer

Общее количество результатов, соответствующих запросу.
Элементы на странице
 itemsPerPage integer

Количество возвращенных результатов.
Начальный индекс
 startIndex integer

1-й индекс первого результата в текущем наборе результатов.
resources
 resources array of object
Идентификатор пользователя
 resources.id integer

Идентификатор пользователя
Имя пользователя
 resources.userName string

Имя пользователя
Внешний идентификатор
 resources.externalId string

Внешний идентификатор
Адрес электронной почты
 resources.email string

Электронная почта пользователя
Отформатированный имя
 resources.name.formatted string

Имя отформатированного пользователем
Фамилия
 resources.name.familyName string

Имя семейства пользователей (фамилия)
Личное имя
 resources.name.givenName string

Имя пользователя (имя)
Active
 resources.active boolean

Активна ли учетная запись пользователя
Заблокировано
 resources.locked boolean

Заблокирована учетная запись пользователя
Дата создания
 resources.createdDate string

Пользователь даты был создан
Дата последнего изменения
 resources.lastModificationDate string

Пользователь последней даты был изменен
Дата последнего активного действия
 resources.lastActiveDate string

Пользователь последней даты был активным
Language
 resources.language string

Параметр "language" принимается только в том случае, если языковой пакет включен для домена.
Тип проверки подлинности
 resources.authType string

Тип проверки подлинности для пользователя.
Тип пользователя
 resources.userType string

Тип пользователя.
Role
 resources.role string

Роль, назначенная пользователю. Применимо только для Power Users.
Идентификатор пользователя поставщика удостоверений
 resources.idpUserId string

Идентификатор пользователя поставщика удостоверений
Учетная запись службы
 resources.isServiceAccount boolean

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

Будет ли учетная запись удалена после истечения срока действия
Ожидается изменение электронной почты
 resources.emailChangePending boolean

Ожидается ли изменение электронной почты пользователя
Дата окончания срока действия
 resources.expiryDate string

Истечение срока действия учетной записи
Основное имя пользователя
 resources.userPrincipalName string

FolderInfoResponse

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

Имя папки.
Последнее изменение
 lastModified integer

Последнее время изменения любого файла в папке (но не в вложенных папках).
Загруженная метка времени
 uploaded integer

Время отправки или создания папки.
Путь к папке
 path string

Полный путь к папке.
Идентификатор папки
 folder_id string

Уникальный идентификатор папки.
Идентификатор родительской папки
 parent_id string

Идентификатор родительской папки.
Число вложенных объектов
 total_count integer

Общее количество элементов, доступных для возврата.
Папка Is
 is_folder boolean

Указывает, является ли ресурс папкой. Истина или Ложь
Возможные общедоступные ссылки
 public_links string

Параметр папки указывает, как было задано значение "Разрешить общедоступные ссылки из этой папки".
Доступно для совместного использования
 allow_links boolean

Доступен ли общий доступ? T или F
Можно удалить или переместить
 restrict_move_delete boolean

Можно ли удалить или переместить? T или F
Папки
 folders array of object

Папки
Имя (вложенная папка)
 folders.name string

Имя папки.
Последнее изменение (вложенная папка)
 folders.lastModified integer

Последнее время изменения любого файла в папке (но не в вложенных папках).
Загруженная метка времени (вложенная папка)
 folders.uploaded integer

Время отправки или создания папки.
Путь (вложенная папка)
 folders.path string

Полный путь к папке по запросу.
Идентификатор (вложенная папка)
 folders.folder_id string

Идентификатор запрошенной папки.
Папка Is (вложенная папка)
 folders.is_folder boolean

Указывает, является ли ресурс папкой. Истина или Ложь
Идентификатор родительской папки (вложенная папка)
 folders.parent_id string

Идентификатор родительской папки.
files
 files array of object

Files
Контрольная сумма (файл)
 files.checksum string

Контрольной суммы текущей версии файла, используемой для определения изменений файлов.
Размер (файл)
 files.size integer

Размер файла в байтах.
Путь (файл)
 files.path string

Полный путь к файлу.
Имя (файл)
 files.name string

Имя файла.
Заблокирован (файл)
 files.locked boolean

Состояние блокировки файла.
Папка Is (file)
 files.is_folder boolean

Указывает, является ли ресурс папкой. Истина или Ложь
Идентификатор версии (файл)
 files.entry_id string

Идентификатор конкретной версии файла.
Идентификатор (файл)
 files.group_id string

Идентификатор для ссылки на файл в целом.
Идентификатор родительской папки (файл)
 files.parent_id string

Идентификатор родительской папки.
Последнее изменение (файл)
 files.last_modified string

Время последнего изменения текущей версии файла.
Отправлено (файл)
 files.uploaded_by string

Имя пользователя, отправив версию.
Загруженная метка времени (файл)
 files.uploaded integer

Время отправки текущей версии файла.
Число версий (файл)
 files.num_versions integer

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

NamespaceItem

Имя Путь Тип Описание
Имя пространства имен
 name string
Область пространства имен
 scope string
ключи
 keys object
отображаемое имя
 displayName string

Имя для идентификации пространства имен в пользовательском интерфейсе
priority
 priority number

Задает приоритет (порядок) для ключей. Ключи будут отображаться в соответствии с их приоритетами в порядке убывания (ключи с более высоким приоритетом будут отображаться сначала)
наследственный
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
Редактируемые
 editable boolean

ProjectItem

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

Идентификатор элемента
Идентификатор корневой папки
 rootFolderId string

Идентификатор корневой папки
Имя
 name string

Имя проекта
Идентификатор проекта
 projectId string

Идентификатор проекта
Имя клиента
 customerName string

Клиент, связанный с проектом
Description
 description string

Описание папки
location
 location ProjectLocationItem
Состояние
 status string

Состояние проекта
Создано автором
 createdBy number

Создано автором
Последнее обновление
 lastUpdatedBy number

Последнее обновление
Время создания
 creationTime string

Время создания
время последнего изменения;
 lastModifiedTime string

время последнего изменения;
Дата начала
 startDate string

Дата начала проекта.
Дата завершения
 completionDate string

Дата завершения проекта.

ProjectLocationItem

Имя Путь Тип Описание
Адрес улицы 1
 streetAddress1 string

Первая строка адреса улицы
Адрес улицы 2
 streetAddress2 string

Вторая строка адреса
Город
 city string

Город
Штат или провинция
 state string

Штат или провинция
Страна
 country string

Страна
Почтовый индекс или почтовый индекс
 postalCode string

Почтовый индекс или почтовый индекс

FileLockWebhookResponse

Имя Путь Тип Описание
Идентификатор файла
 targetGroupId string
Контрольная сумма файлов
 targetFileChecksum string
Путь к файлу
 targetPath string

FolderProjectCommon

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

WorkflowStepResponse

Имя Путь Тип Описание
Идентификатор рабочего процесса
 workflow.id string
Имя рабочего процесса
 workflow.name string
Идентификатор отображения рабочего процесса
 workflow.displayId number
Тип рабочего процесса
 workflow.type string
Идентификатор шаблона рабочего процесса
 workflow.templateId string
Состояние действия рабочего процесса
 workflow.actionStatus string
Первый тип сущности
 firstEntity.type string
Путь к первой сущности
 firstEntity.filePath string
Идентификатор записи первой сущности
 firstEntity.entryID string
Идентификатор первой группы сущностей
 firstEntity.groupID string
Идентификатор шага
 step.id string
Имя шага
 step.name string
Тип шага
 step.type string
Идентификатор назначаемого получателя
 assignee.id number
Отображаемое имя назначаемого получателя
 assignee.displayName string
Имя пользователя Назначаемого пользователя
 assignee.username string
Назначение электронной почты
 assignee.email string
Общее количество шагов
 totalNumberOfSteps number
Дата завершения
 completionDate number
Дата создания
 creationDate number

AIQuestionResponse

Имя Путь Тип Описание
response
 response AIResponse
Цитаты
 citations array of AICitation

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

AISummaryResponse

Имя Путь Тип Описание
response
 response AIResponse

AICopilotResponse

Имя Путь Тип Описание
response
 response AIResponse
Цитаты
 citations array of AICitation

Ссылки и ссылки, используемые при создании ответа
ID разговора
 conversationId string

Уникальный идентификатор беседы

AICitation

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

Имя исходного файла
Идентификатор записи
 entryId string

Идентификатор записи исходного файла
Блоки текста
 chunks array of object

Массив фрагментов текста из источника
Идентификатор блока
 chunks.chunkId string

Идентификатор фрагмента текста
Исходный текст
 chunks.sourceText string

Текстовое содержимое блока

AIResponse

Имя Путь Тип Описание
Текст ответа
 text string

Текст ответа, созданный ИИ

KnowledgeBaseListResponse

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

Список записей базы знаний
Идентификатор базы знаний
 content.id string

Уникальный идентификатор записи базы знаний
Имя
 content.name string

Имя записи базы знаний
Description
 content.description string

Описание записи базы знаний
Paths
 content.paths array of object

Список путей папок, связанных с записью базы знаний
Идентификатор пути
 content.paths.id string

Уникальный идентификатор пути
Идентификатор папки
 content.paths.folderId string

Идентификатор папки, связанной с кб
Путь
 content.paths.path string

Путь к файлу, в котором документы хранятся в базе знаний
Разрешение
 content.paths.permission string

Уровень разрешений для пути
Состояние пути
 content.paths.status string

Текущее состояние пути
Состояние
 content.status string

Состояние записи базы знаний
Тип
 content.type string

Тип записи базы знаний
Создано автором
 content.createdBy string

Отображаемое имя пользователя, создавшего базу знаний
Имя (Первое имя)
 content.createdByUser.firstName string
Фамилия
 content.createdByUser.lastName string
Имя пользователя
 content.createdByUser.userName string
Идентификатор пользователя
 content.createdByUser.userId integer
Создано
 content.createdOn integer

Метка времени создания базы знаний
Сообщение ответа не
 content.noResponseMessage string

Ответ обратной связи при отсутствии ответа искусственного интеллекта
Имя значка
 content.iconName string

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

Определяется ли база знаний системой или определяемая пользователем
Progress
 content.progress integer

Ход обработки базы знаний (процент)
Последнее обработанное в
 content.lastProcessedAt integer

Метка времени последнего обработки базы знаний
Число путей
 content.pathCount integer

Число путей, связанных с кб
Подсказки
 content.prompts array of object

Список запросов, связанных с кб
items
 content.prompts object
Номер страницы
 number integer

Текущий номер страницы в ответе с разбивкой на страницы
Размер страницы
 size integer

Максимальное количество элементов на страницу
Первая страница
 first boolean

Указывает, является ли это первой страницей
Последняя страница
 last boolean

Указывает, является ли эта последняя страница
Пусто
 empty boolean

Указывает, является ли содержимое пустым
Количество элементов
 numberOfElements integer

Количество элементов на текущей странице
Всего элементов
 totalElements integer

Общее количество элементов на всех страницах
Всего страниц
 totalPages integer

Общее количество страниц
Ограничение файлов
 fileLimit integer

Максимально допустимое количество файлов

HybridSearchResponse

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

Список результатов поиска
Filename
 results.filename string

Имя файла
Идентификатор записи
 results.entryId string

Идентификатор для ссылки на определенную версию файла.
Идентификатор группы
 results.groupId string

Идентификатор для ссылки на файл в целом.
Куски
 results.chunks array of object

Список блоков содержимого
Идентификатор блока
 results.chunks.chunkId string

Уникальный идентификатор блока содержимого
Фрагмент текста
 results.chunks.chunkText string

Текстовое содержимое блока
Тип
 results.chunks.type string

Тип блока (TEXT или TABLE)
Балл
 results.chunks.score float

Оценка релевантности для этого блока

AgentListResponse

Список доступных агентов

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

Уникальный идентификатор агента
Имя
 name string

Имя агента
Description
 description string

Описание функциональных возможностей агента
Состояние
 status string

Текущее состояние агента (DRAFT, ACTIVE, DELETED и т. д.)
Подтип
 subType string

Подтип агента (например, TRANSLATION_AGENT)
Категория
 category string

Категория агента (TASK, ВОПРОС и т. д.)
Инструкция
 instruction string

Основные инструкции, предоставленные агенту
Создано автором
 createdBy string

Пользователь, создавший агент

AskAgentResponse

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

Уникальный идентификатор отправленного запроса
ID разговора
 conversationId string

Уникальный идентификатор беседы

AgentExecutionStatusResponse

Имя Путь Тип Описание
Состояние
 status string

Текущий статус исполнения
Текст ответа
 responseText string

Окончательный ответ, созданный агентом. Присутствует только в том случае, если состояние завершено.
Цитаты
 citations array of object

Ссылки или источники, используемые для создания ответа
URL-адрес предварительной версии
 citations.previewUrl string

Ссылка на источник
Тип
 citations.type string

Тип источника (например, WEB_SEARCH)
Последнее обновление
 lastUpdated integer

Метка времени последнего обновления до ответа или состояния (в миллисекундах)