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

Objective Connect (предварительная версия)

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

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

Услуга 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)
Метаданные соединителя
Publisher Целевая корпорация

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
Пароль securestring Пароль для этого API True
Регион сервера. (Великобритания - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) струна Укажите сервер Objective Connect. True
Имя пользователя securestring Имя пользователя для этого API True

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

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

Действия

Вывод списка версий документов

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

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

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

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

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

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

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

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

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

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

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

Если запрос — application:hal+json, он создает только метаданные. Если запрос имеет значение multipart:form-data, он создает документ с содержимым в одном вызове.
Создание рабочей области

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

Удаляет участника из рабочей области

Вывод списка версий документов

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

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

Параметры

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

Идентификатор UUID документа
Workspace
 shareUuid True string

UUID рабочей области
Length
 length integer

Максимальное количество полученных результатов
Смещение
 offset integer

Результат запуска (по умолчанию — 0).

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

response
array of DocumentVersion

Вывод списка общих документов

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

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

Параметры

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

UUID рабочей области
Length
 length integer

Максимальное количество полученных результатов
Смещение
 offset integer

Результат, с которого начинаются возвращаемые значения (по умолчанию — 0)
Родительский UUID
 parentUuid string

Идентификатор UUID общего ресурса или родительского ресурса. Если предоставленные результаты будут ограничены непосредственными дочерними элементами общей папки или актива. Если это недопустимо, ответ будет 200 с пустым списком.
Query
 query string

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

Строка условий сортировки. Допустимые значения:

  • имя
  • дата создания
  • modifiedDate
  • Размер условий сортировки можно при необходимости следовать ":d esc", чтобы указать, что сортировка должна находиться в порядке убывания. Если параметр sortInfo не указан или содержит недопустимые значения, список будет отсортирован по имени ресурса по возрастанию

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

Имя Путь Тип Описание
array of object
заметкиCount
 annotationsCount integer

заметкиCount
commentCount
 commentCount integer

commentCount
версия содержимого
 contentVersion integer

версия содержимого
дата создания
 createdDate string

дата создания
Расширение
 extension string

Расширение
размер файла
 fileSize integer

размер файла
locked
 locked boolean

locked
model
 model string

model
modifiedByUuid
 modifiedByUuid string

modifiedByUuid
modifiedDate
 modifiedDate string

modifiedDate
имя
 name string

имя
pdfPreviewstatus
 pdfPreviewstatus string

pdfPreviewstatus
previewPageCount
 previewPageCount integer

previewPageCount
previewstatus
 previewstatus string

previewstatus
статус
 status string

статус
type
 type string

type
UUID (Универсальный уникальный идентификатор)
 uuid string

UUID (Универсальный уникальный идентификатор)
wopiRestricted
 wopiRestricted boolean

wopiRestricted

Вывод списка рабочих областей

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

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

Параметры

Имя Ключ Обязательно Тип Описание
Length
 length integer

Максимальное количество полученных результатов
Смещение
 offset integer

Результат, с которого начинаются возвращаемые значения (по умолчанию — 0)
Владелец
 ownerUuid string

Идентификатор пользователя UUID владельца. Если предоставленные результаты будут ограничены общими папками, принадлежащими этому пользователю
Участник
 participantUuid string

Идентификатор UUID участника. Если предоставленные результаты будут ограничены общими папками, в которых этот пользователь является участником
Query
 query string

Строка запроса поиска. Если предоставленные результаты будут ограничены общими папками с именем, содержащим заданное значение запроса.
Сортировать
 sort string

Строка условий сортировки. Допустимые значения:

  • имя
  • дата создания
  • modifiedDate
  • Присоединился к
  • shareOrder
  • Организация Критерии сортировки могут быть при необходимости следовать ":d esc", чтобы указать, что сортировка должна находиться в порядке убывания. Если параметр sortInfo не указан или содержит недопустимые значения, список будет отсортирован по имени общего ресурса по возрастанию.
Рабочая группа
 workgroupUuid string

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

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

response
array of ShareResponse

Добавление или обновление участника

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

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

Параметры

Имя Ключ Обязательно Тип Описание
сообщения электронной почты
 emails True array of string

сообщения электронной почты
Message
 message string

Сообщение приглашения
roles
 roles array of string

roles
UUID рабочей области
 shareUuid True string

UUID (Универсальный уникальный идентификатор)
Видимость участника
 type string

STANDARD — видимый другим участникам. BCC - участник будет скрыт от других пользователей

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

Имя Путь Тип Описание
array of object
принято
 accepted boolean

принято
электронная почта
 email string

электронная почта
isOwner
 isOwner boolean

isOwner
model
 model string

model
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
type
 type string

type
UUID (Универсальный уникальный идентификатор)
 uuid string

UUID (Универсальный уникальный идентификатор)

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

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

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

Параметры

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

Идентификатор UUID документа
Workspace
 shareUuid True string

UUID рабочей области
Содержимое файла
 file True file

Содержимое файла для отправки

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

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

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

Параметры

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

UUID (Универсальный уникальный идентификатор)
Workspace
 shareUuid True string

UUID (Универсальный уникальный идентификатор)
Версия
 version True integer

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

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

Тело
DocumentVersion

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

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

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

Параметры

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

Адрес электронной почты для поиска
Length
 length integer

Количество возвращаемых результатов. Используется только в том случае, если используется смещение.
Смещение
 offset integer

Возврат результатов после этой позиции
Организация
 orgUuid string

UUID организации для поиска
Сортировать
 sort string

Параметр — сортировка должна иметь формат слова, указывающего поле сортировки необязательного тега ":d esc", если не предполагается возрастание. Недопустимые или пустые запросы по умолчанию по возрастанию. Доступные сортировки : firstName, lastName, email
Пользовательские UUIDs
 uuids array

Список пользовательских uuids

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

response
array of UserResponse

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

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

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

Параметры

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

uuid рабочей области для получения

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

Тело
ShareResponse

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

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

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

Параметры

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

UUID (Универсальный уникальный идентификатор)
Версия содержимого
 contentVersion True integer

Номер версии документа
Workspace
 shareUuid True string

UUID (Универсальный уникальный идентификатор)

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

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

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

Параметры

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

UUID (Универсальный уникальный идентификатор)
Workspace
 shareUuid True string

UUID (Универсальный уникальный идентификатор)

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

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

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

Параметры

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

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

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

Имя Путь Тип Описание
array of object
принято
 accepted boolean

принято
электронная почта
 email string

электронная почта
isOwner
 isOwner boolean

isOwner
joinedDate
 joinedDate string

joinedDate
model
 model string

model
имя
 name string

имя
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
type
 type string

type
UUID (Универсальный уникальный идентификатор)
 uuid string

UUID (Универсальный уникальный идентификатор)

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

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

Если запрос — application:hal+json, он создает только метаданные. Если запрос имеет значение multipart:form-data, он создает документ с содержимым в одном вызове.

Параметры

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

Общий uuid из пути
Содержимое файла
 file True file

Содержимое файла для отправки
Имя файла
 name True string

Имя файла
Родительский UUID
 parentUuid string

(Необязательно)
Сводка
 summary string

(Необязательно)

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

Тело
AssetReturnDocumentResponse

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

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

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

Параметры

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

Идентификатор UUID пользователя
Доступ
 access string
Агент
 agentShareToken string

Маркер агента
Имя
 name True string

Имя
Организация
 organisationUuid string

UUID организации
Владелец
 ownerUuid string

Владелец UUID
Сводка
 summary string

Сводка
UUID (Универсальный уникальный идентификатор)
 uuid string

UUID (Универсальный уникальный идентификатор)

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

Тело
ShareResponse

Удаление участника

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

Удаляет участника из рабочей области

Параметры

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

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

Определения

Доступ

Доступ
string

AssetReturnDocumentResponse

Имя Путь Тип Описание
commentCount
 commentCount integer
версия содержимого
 contentVersion integer
дата создания
 createdDate string
Расширение
 extension string
размер файла
 fileSize integer
locked
 locked boolean
model
 model string
modifiedByUuid
 modifiedByUuid string
modifiedDate
 modifiedDate string
имя
 name string
parentUuid
 parentUuid string
previewPageCount
 previewPageCount integer
previewstatus
 previewstatus PreviewStatus
статус
 status AssetStatus
summary
 summary string
type
 type AssetType
UUID (Универсальный уникальный идентификатор)
 uuid string
wopiRestricted
 wopiRestricted boolean

AssetStatus

string

AssetType

string

DocumentVersion

Имя Путь Тип Описание
дата создания
 createdDate string
Расширение
 extension string
размер файла
 fileSize integer
model
 model string
статус
 status AssetStatus
UUID (Универсальный уникальный идентификатор)
 uuid string
version
 version integer

EndOnDateOptionalValue

Имя Путь Тип Описание
присутствующий
 present boolean
value
 value string

NotificationPreference

NotificationPreference
string

PreviewStatus

string

ShareResponse

Имя Путь Тип Описание
Доступ
 access Access
connections
 connections integer
дата создания
 createdDate string
EndOnDateOptionalValue
 endOnDateOptionalValue EndOnDateOptionalValue
model
 model string
modifiedDate
 modifiedDate string
имя
 name string
organizationUuid
 organisationUuid string
ownerUuid
 ownerUuid string
безопасный
 secure boolean
ShareStatus
 shareStatus ShareStatus
статус
 status AssetStatus
SynchStatus
 synchStatus SynchStatus
UUID (Универсальный уникальный идентификатор)
 uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

UserResponse

Имя Путь Тип Описание
disabled
 disabled boolean
электронная почта
 email string
Имя
 firstName string
hideEmailAddress
 hideEmailAddress boolean
lastName
 lastName string
model
 model string
notificationPreferences
 notificationPreferences array of NotificationPreference
organizationUuid
 organisationUuid string
roles
 roles array of string
UserStatus
 status UserStatus
timezone
 timezone string
UUID (Универсальный уникальный идентификатор)
 uuid string

UserStatus

UserStatus
string