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

Обновлено: 03.07.2024

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

Примеры использования Document File Manager API включают реализацию следующих функций:

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

API Document File Manager поддерживает те же функции для этой службы, что и REST API. Дополнительные сведения см. в разделе API диспетчера файлов документов.

Эта страница содержит следующую информацию:

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

Получить информацию о файле документа

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

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

Отправьте запрос GET, используя следующий формат URL:

Установите > идентификатор артефакта рабочей области, содержащей документ, а > — идентификатор артефакта документа. См. следующий образец URL:

Тело запроса пусто.

Ответ содержит массив объектов DocumentFile. Каждый объект имеет следующие поля:

  • Guid – уникальный универсальный идентификатор файла.
  • Имя файла – имя файла.
  • Идентификатор — уникальная строка, используемая для идентификации файла. В следующем примере JSON это поле отсутствует.
  • Порядок – целочисленное значение, указывающее положение файла в наборе файлов одного типа. Только типы файлов OriginalImage и ProducedImage имеют ненулевое значение для этого поля.
  • FileType — тип файла. Следующий список включает допустимые значения для этого поля:
    • Нативный
    • Исходное изображение
    • Произведенное изображение

    Для получения дополнительной информации см. перечисление DocumentFileType в пространстве имен Relativity.Services.Interfaces.Document.Models Namespace в справочнике по API Relativity.

    • Не установлено
    • Ноль градусов
    • Девяносто градусов
    • Сто восемьдесят градусов
    • Двестисемьдесят градусов

    Дополнительную информацию см. в перечислении DocumentFileRotation в пространстве имен Relativity.Services.Interfaces.Document.Models Namespace в справочнике по API Relativity.

    Скачать файлы

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

    • DownloadFile — загружает файл на основе указанного вами идентификатора GUID. См. Загрузка файла по GUID.
    • DownloadNativeFile — обеспечивает ту же функциональность, что и вызов конечной точки DownloadFile с GUID для собственного файла, за исключением того, что вы указываете идентификатор артефакта документа. См. раздел Загрузка собственного файла по идентификатору артефакта документа.

    Эти конечные точки возвращают двоичные данные файла. Ответ содержит эти заголовки со следующими настройками:

    • Transfer-Encoding — для этого заголовка задано фрагментирование.
    • Content-Type — расширение файла определяет значение этого заголовка.
    • Content-Disposition — имя файла, определенное в Relativity, определяет имя файла в вложении; имя_файла=.

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

    Скачать файл по GUID

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

    Отправьте запрос GET, используя следующий формат URL:

    Задайте > идентификатор артефакта рабочей области, содержащей документ, а > — идентификатор GUID файла. См. следующий образец URL:

    Если запрос выполнен успешно, ответ возвращает код состояния 200, и файл сохраняется на диск с именем файла, указанным в заголовке Content-Disposition.

    Загрузить собственный файл по идентификатору артефакта документа

    Вы можете загрузить собственный файл, указав идентификатор артефакта связанного с ним документа.Эта удобная конечная точка работает аналогично вызову конечной точки DownloadFile с GUID для собственного файла, за исключением того, что вы указываете идентификатор артефакта документа.

    Отправьте запрос GET, используя следующий формат URL:

    Установите > идентификатор артефакта рабочей области, содержащей документ, а > — идентификатор артефакта документа. См. следующий образец URL:

    Если запрос выполнен успешно, ответ возвращает код состояния 200, и файл сохраняется на диск с именем файла, указанным в заголовке Content-Disposition.

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

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

    В силу этой компании Readdle принимает меры для принятия мер:

    • Мы удалили все наши продукты из App Store и Google Play в России;
    • Мы не сотрудничаем с крупными независимыми гражданами или имеем к ним отношение;
    • Мы не ведем бизнес с крупными, которые продолжают обсуждать войну в Украине, острую российскую агрессию в Украине или покрываются иностранными гражданами, выступающими на стороне захватчика.

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

    • Для текущих пользователей:
      Для текущих пользователей в России доступ к установленным приложениям журнала, но все новые функции и обновление безопасности с нашей стороны применения не будут. Кроме того, мы больше не будем требовать «технической поддержки» наших приложений из России.
    • Для новых пользователей:
      Приложения Readdle больше не будут доступны для продажи в российском App Store и Google Play. Мы не будем предлагать наши продукты и услуги пользователям в России.

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

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

    API Document File Manager предоставляет методы для загрузки собственных файлов, файлов изображений и созданных файлов изображений, связанных с документами в Relativity. Вы можете загрузить файл, указав его GUID, или вы можете загрузить собственный файл, указав идентификатор артефакта связанного с ним документа. API диспетчера файлов документов также поддерживает получение информации об этих файлах, такой как идентификатор GUID, имя, тип, размер и т. д.

    Примеры использования Document File Manager API включают реализацию следующих функций:

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

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

    Эта страница содержит следующую информацию:

    Основы работы с Document File Manager API

    API Document File Manager содержит следующие методы, классы и перечисления.

    Методы

    API Document File Manager предоставляет следующие методы интерфейса IDocumentFileManager в пространстве имен Relativity.Services.Interfaces.Document:

    • Метод DownloadFileAsync() — загружает исходный файл, изображение или созданный файл изображения на основе указанного идентификатора GUID. Его параметры включают идентификатор артефакта рабочей области, содержащей документ, и идентификатор GUID загружаемого файла. Он возвращает поток, содержащий файл. См. Загрузка файла по GUID.
    • Метод DownloadNativeFileAsync() — загружает собственный файл, указывая идентификатор артефакта связанного с ним объекта Document. Его параметры включают в себя идентификаторы артефактов рабочей области и объекта документа. Он возвращает поток, содержащий файл. См. раздел Загрузка собственного файла по идентификатору артефакта документа.
    • Метод GetFileInfoAsync() — извлекает информацию о файлах, связанных с документом в Relativity. Его параметры включают в себя идентификаторы артефактов рабочей области и объекта документа. Этот метод возвращает список объектов DocumentFile. См. раздел Получение информации о файле документа.

    Классы и перечисления

    API Document File Manager включает следующие классы и перечисления, доступные в пространстве имен Relativity.Services.Interfaces.Document.Models:

    • Класс DocumentFile — представляет информацию о собственном файле, файле изображения или созданном файле изображения. Его свойства включают GUID, имя, тип, размер и другие. Метод GetFileInfoAsync() возвращает объект этого типа. См. класс DocumentFile в Services API.
    • Перечисление DocumentFileRotation — указывает ротацию файла. Допустимые значения включают:
      • Не установлено
      • Ноль градусов
      • Девяносто градусов
      • Сто восемьдесят градусов
      • Двестисемьдесят градусов
      • Перечисление DocumentFileType — указывает тип файла. Допустимые значения: Native, OriginalImage и ProducedImage.

      Для получения дополнительной информации см. пространство имен Relativity.Services.Interfaces.Document.Models в Services API.

      Получить информацию о файле документа

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

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

      В следующем примере кода показано, как передать идентификаторы артефактов рабочей области и объекта Document в метод GetFileInfoAsync(). Метод возвращает список объектов DocumentFile, а общее количество записывается в консоль.

      Скачать файлы

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

      • ContentType — расширение файла определяет значение этого заголовка.
      • ContentDisposition — имя файла, определенное в Relativity, определяет имя файла в вложении; имя файла=. См. Загрузка файла по GUID

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

      Скачать файл по GUID

      Вы можете загрузить исходный файл, изображение или созданный файл изображения, указав его GUID в вызове метода DownloadFileAsync(). Чтобы получить GUID загружаемого файла, используйте метод GetFileInfoAsync(). См. раздел Получение информации о файле документа.

      В следующем примере кода показано, как передать идентификатор артефакта рабочей области и идентификатор GUID для файла в метод DownloadFileAsync(). Этот метод возвращает поток, содержащий файл. Он сохраняет файл на диск, используя имя файла, указанное в заголовке ContentDisposition.

      Загрузить собственный файл по идентификатору артефакта документа

      Вы можете загрузить собственный файл, вызвав метод DownloadNativeFileAsync() и указав идентификатор артефакта связанного с ним документа. Этот удобный метод работает аналогично вызову конечной точки DownloadFile с GUID для собственного файла, за исключением того, что вы указываете идентификатор артефакта объекта Document.

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

      Суперприложение для iPhone и iPad. Читайте, слушайте, просматривайте, комментируйте почти все, что хотите, на своем iPad и iPhone. Файлы, документы, книги, любой контент у вас дома в Documents by Readdle. Это Finder для iOS, о котором вы всегда мечтали.

      Выбор редакции App Store в более чем 70 странах

      "Это инструмент, который поможет вам быть более организованным". - The Verge
      «Приложение очень быстрое, оно хорошо выглядит, а параметры легко найти и использовать». – The Next Web
      «Удивительно универсальное приложение как для частных лиц, так и для бизнеса». – США сегодня

      Приложение "Документы" — это наиболее функциональное приложение на вашем устройстве iOS. Это центр для всех ваших файлов, поскольку он заменяет средство просмотра документов, программу чтения PDF-файлов, функцию «прочитать позже», музыкальный и видеоплеер, загрузчик файлов, облачный интегратор и множество других приложений в одном элегантном приложении.
      Поразительное внимание к деталям, непревзойденная стабильность и дизайн отличают Documents от любого приложения на iPhone или iPad. Вы будете использовать его постоянно, дома, в офисе, в университете или в дороге, каждый божий день.
      Просто взгляните на краткий список вещей, которые Documents позволяет вам делать. Это приложение делает ваш iPad и iPhone достойным внимания!

      ◆ИМПОРТ И СОХРАНЕНИЕ ФАЙЛОВ◆
      + Импорт файлов с вашего компьютера, облака, WebDav или любых устройств поблизости
      + Загрузка файлов из Интернета
      + Хранение вложений электронной почты
      + Сохраняйте веб-страницы, чтобы прочитать их позже

      ◆УПРАВЛЕНИЕ ФАЙЛАМИ◆
      + Управляйте своими файлами и создавайте папки
      + Заархивируйте/разархивируйте, пометьте цветом, переименуйте и т. д.
      + Перетаскивайте файлы между приложениями (!). Откройте два приложения Readdle в режиме Split View на iPad* и просто перемещайте файлы между ними
      + Делитесь файлами с друзьями
      + Защитите все паролем
      *iPad Pro, iPad Air 2 и iPad mini 4

      ◆ДОСТУПИТЕ К ЛЮБИМОМУ КОНТЕНТУ С ПОМОЩЬЮ БЕЗОПАСНОЙ VPN◆
      + VPN шифрует ваши данные, чтобы никто не подглядывал за вами, пока вы отправляете важное электронное письмо или пользуетесь интернет-банкингом в местном магазине тако.

      ◆ИНТЕГРАЦИЯ ВСЕХ ОБЛАЧНЫХ СЛУЖБ◆
      + Подключайте все облачные сервисы к Документам и получайте доступ к своим личным и рабочим файлам в любое время
      + Работайте в iCloud, Dropbox, Google Диске и других Сервисах, не загружая файлы
      + Настройте двустороннюю синхронизацию с определенными папками для автоматической загрузки файлов

      ◆УМНЫЕ ДЕЙСТВИЯ◆
      + Контекстные рекомендации, которые экономят ваше время и предлагают наилучшие следующие действия.

      ◆ДОСТУП К СВОИМ ФАЙЛАМ ОДНИМ КАСАНИЕМ◆
      + Все ваши облачные хранилища размещены в разделе «Мои файлы».

      ◆СЛУШАЙТЕ и ПРОСМОТР◆
      + Слушайте музыку онлайн и офлайн
      + Смотрите фильмы, импортируя их со своего компьютера или из онлайн-источников
      + Отличный и простой доступ к вашей фотобиблиотеке

      ◆ЧИТАЙТЕ И РЕДАКТИРУЙТЕ PDF-файлы◆
      + Открывайте файлы Office и электронные книги
      + Просматривайте и редактируйте PDF-файлы
      + Изменяйте текст и изображения PDF
      + Управляйте страницами в своих PDF-файлах< br />+ Конвертировать что угодно в PDF

      Документы — это обязательное приложение для вашего iPhone и iPad!
      Если вы решите приобрести Documents Plus, оплата будет снята с вашей учетной записи iTunes, а с вашей учетной записи будет взиматься плата за продление в течение 24 часов до конец текущего периода. Автообновление можно отключить в любое время, зайдя в настройки в iTunes Store после покупки. Стоимость подписки Current Documents Plus начинается с 12,49 долларов США в месяц. Цены указаны в долларах США, могут отличаться в других странах, кроме США, и могут быть изменены без предварительного уведомления. Если вы не решите приобрести Documents Plus, вы можете просто продолжать использовать Documents бесплатно. Любая неиспользованная часть бесплатного пробного периода, если она предлагается, будет аннулирована при покупке подписки, где это применимо.

      Читайте также: