Udostępnij przez

Objective Connect (wersja zapoznawcza)

Objective Connect to zaufana platforma udostępniania plików, która umożliwia organizacji udostępnianie poufnych dokumentów stronom zewnętrznym. Użytkownicy mogą tworzyć prywatne obszary robocze i zapraszać uczestników w chmurze w ciągu kilku sekund. Funkcje współpracy, raportowania, zabezpieczeń i zgodności umożliwiają rządom i regulowanym branżom możliwość pracy zewnętrznej przy zachowaniu spokoju umysłu.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Metadane łącznika
Publisher Objective Corporation

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Hasło securestring Hasło dla tego interfejsu API Prawda
Region serwera. (Wielka Brytania - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) ciąg Określ serwer Objective Connect. Prawda
Nazwa użytkownika securestring Nazwa użytkownika dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Dodawanie lub aktualizowanie uczestnika

Zaproś nowego uczestnika lub edytuj przypisane role
Pobieranie obszaru roboczego

Pobieranie obszaru roboczego według identyfikatora
Pobieranie uczestników

Pobieranie uczestników obszaru roboczego
Pobieranie użytkownika

Pobieranie użytkowników
Pobieranie wersji dokumentu

Pobieranie wersji elementu zawartości
Pobieranie zawartości dokumentu

Zwraca zawartość dokumentu
Pobieranie zawartości wersji dokumentu

Zwraca zawartość wersji dokumentu
Przekazywanie zawartości dokumentu

Przekazywanie zawartości dokumentu
Tworzenie dokumentu

Jeśli żądanie to application:hal+json, tworzy tylko metadane. Jeśli żądanie to multipart:form-data, tworzy dokument z zawartością w jednym wywołaniu.
Tworzenie obszaru roboczego

Tworzenie obszaru roboczego
Usuwanie uczestnika

Usuwa uczestnika z obszaru roboczego
Wyświetlanie listy dokumentów udostępnionych

Pobieranie listy zasobów według identyfikatora UUID obszaru roboczego
Wyświetlanie listy obszarów roboczych

Pobierz listę udziałów, które użytkownik żądający ma uprawnienia do wyświetlenia
Wyświetlanie listy wersji dokumentów

Pobieranie listy wersji zasobów

Dodawanie lub aktualizowanie uczestnika

Identyfikator operacji:
AddParticipant

Zaproś nowego uczestnika lub edytuj przypisane role

Parametry

Nazwa Klucz Wymagane Typ Opis
wiadomości e-mail
 emails True array of string

wiadomości e-mail
Message
 message string

Wiadomość z zaproszeniem
roles
 roles array of string

roles
Identyfikator UUID obszaru roboczego
 shareUuid True string

UUID
Widoczność uczestnika
 type string

STANDARD — widoczny dla innych uczestników. BCC — uczestnik będzie ukryty przed innymi

Zwraca

Nazwa Ścieżka Typ Opis
array of object
zaakceptowano
 accepted boolean

zaakceptowano
e-mail
 email string

e-mail
isOwner
 isOwner boolean

isOwner
model
 model string

model
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
typ
 type string

typ
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string

UUID (Uniwersalnie Unikalny Identyfikator)

Pobieranie obszaru roboczego

Identyfikator operacji:
GetWorkspace

Pobieranie obszaru roboczego według identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Workspace
 shareUuid True string

Identyfikator uuid obszaru roboczego do pobrania

Zwraca

Body
ShareResponse

Pobieranie uczestników

Identyfikator operacji:
GetParticipants

Pobieranie uczestników obszaru roboczego

Parametry

Nazwa Klucz Wymagane Typ Opis
User
 userUuid string

Identyfikator UUID użytkownika

Zwraca

Nazwa Ścieżka Typ Opis
array of object
zaakceptowano
 accepted boolean

zaakceptowano
e-mail
 email string

e-mail
isOwner
 isOwner boolean

isOwner
joinedDate
 joinedDate string

joinedDate
model
 model string

model
nazwa
 name string

nazwa
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
typ
 type string

typ
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string

UUID (Uniwersalnie Unikalny Identyfikator)

Pobieranie użytkownika

Identyfikator operacji:
GetUser

Pobieranie użytkowników

Parametry

Nazwa Klucz Wymagane Typ Opis
Email
 emailAddress string

Adres e-mail do wyszukania
Długość
 length integer

Liczba wyników do zwrócenia. Używane tylko wtedy, gdy jest używane przesunięcie.
Przesunięcie
 offset integer

Zwróć wyniki po tej pozycji
Organizacja
 orgUuid string

UUID organizacji do poszukiwania
Sortuj
 sort string

Parametrm — sortowanie powinno mieć format słowa wskazującego pole sortowania opcjonalny tag ":d esc", jeśli nie występuje rosnąco. Nieprawidłowe lub puste żądania są domyślne dla rosnącej nazwy. Dostępne sortowania to: firstName, lastName, email
Identyfikatory UUID użytkownika
 uuids array

Lista identyfikatorów użytkownika

Zwraca

response
array of UserResponse

Pobieranie wersji dokumentu

Identyfikator operacji:
GetDocumentVersion

Pobieranie wersji elementu zawartości

Parametry

Nazwa Klucz Wymagane Typ Opis
Dokument
 assetUuid True string

UUID
Workspace
 shareUuid True string

UUID
wersja
 version True integer

Numer wersji dokumentu

Zwraca

Body
DocumentVersion

Pobieranie zawartości dokumentu

Identyfikator operacji:
GetDocumentContent

Zwraca zawartość dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Dokument
 assetUuid True string

UUID
Workspace
 shareUuid True string

UUID

Pobieranie zawartości wersji dokumentu

Identyfikator operacji:
GetDocumentVersionContent

Zwraca zawartość wersji dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Dokument
 assetUuid True string

UUID
Wersja zawartości
 contentVersion True integer

Numer wersji dokumentu
Workspace
 shareUuid True string

UUID

Przekazywanie zawartości dokumentu

Identyfikator operacji:
UploadDocumentContent

Przekazywanie zawartości dokumentu

Parametry

Nazwa Klucz Wymagane Typ Opis
Dokument
 assetUuid True string

Identyfikator UUID dokumentu
Workspace
 shareUuid True string

Identyfikator UUID obszaru roboczego
Zawartość pliku
 file True file

Zawartość pliku do przekazania

Tworzenie dokumentu

Identyfikator operacji:
CreateDocument

Jeśli żądanie to application:hal+json, tworzy tylko metadane. Jeśli żądanie to multipart:form-data, tworzy dokument z zawartością w jednym wywołaniu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator UUID obszaru roboczego
 shareUuid True string

Identyfikator uuid udziału ze ścieżki
Zawartość pliku
 file True file

Zawartość pliku do przekazania
Nazwa pliku
 name True string

Nazwa pliku
Identyfikator UUID elementu nadrzędnego
 parentUuid string

(Opcjonalnie)
Podsumowanie
 summary string

(Opcjonalnie)

Zwraca

Body
AssetReturnDocumentResponse

Tworzenie obszaru roboczego

Identyfikator operacji:
CreateWorkspace

Tworzenie obszaru roboczego

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator UUID użytkownika
 userUuid True string

Identyfikator UUID użytkownika
Access
 access string
Przedstawiciel
 agentShareToken string

Token agenta
Name
 name True string

Name
Organization
 organisationUuid string

Identyfikator UUID organizacji
Właściciel
 ownerUuid string

Identyfikator UUID właściciela
Podsumowanie
 summary string

Podsumowanie
UUID
 uuid string

UUID

Zwraca

Body
ShareResponse

Usuwanie uczestnika

Identyfikator operacji:
DeleteParticipant

Usuwa uczestnika z obszaru roboczego

Parametry

Nazwa Klucz Wymagane Typ Opis
User
 uuid True string

Identyfikator UUID użytkownika

Wyświetlanie listy dokumentów udostępnionych

Identyfikator operacji:
ListDocuments

Pobieranie listy zasobów według identyfikatora UUID obszaru roboczego

Parametry

Nazwa Klucz Wymagane Typ Opis
Workspace
 shareUuid True string

Identyfikator UUID obszaru roboczego
Długość
 length integer

Maksymalna liczba wyników do pobrania
Przesunięcie
 offset integer

Wynik, na którym zaczynają się zwracane wartości (domyślnie to 0)
Identyfikator UUID elementu nadrzędnego
 parentUuid string

Identyfikator UUID udziału lub elementu zawartości nadrzędnej. Jeśli pod warunkiem, że wyniki zostaną ograniczone do natychmiastowych elementów podrzędnych udziału lub zasobu. Jeśli jest nieprawidłowa, odpowiedź będzie mieć wartość 200 z pustą listą.
Query
 query string

Ciąg zapytania wyszukiwania. Jeśli pod warunkiem, że wyniki będą ograniczone do zasobów o nazwie rozpoczynającej się od podanej wartości zapytania.
Sortuj
 sort string

Ciąg kryteriów sortowania. Dopuszczalne wartości to

  • nazwa
  • data utworzenia
  • modifiedDate
  • size Kryteria sortowania mogą być opcjonalne, a następnie ":d esc", aby wskazać, że sortowanie powinno być w kolejności malejącej. Jeśli nie podano informacji o sortowaniu lub zawiera nieprawidłowe wartości, lista zostanie posortowana według rosnącej nazwy zasobu

Zwraca

Nazwa Ścieżka Typ Opis
array of object
annotationsCount
 annotationsCount integer

annotationsCount
commentCount
 commentCount integer

commentCount
wersja zawartości
 contentVersion integer

wersja zawartości
data utworzenia
 createdDate string

data utworzenia
rozszerzenie
 extension string

rozszerzenie
rozmiar pliku
 fileSize integer

rozmiar pliku
zablokowany
 locked boolean

zablokowany
model
 model string

model
modifiedByUuid
 modifiedByUuid string

modifiedByUuid
modifiedDate
 modifiedDate string

modifiedDate
nazwa
 name string

nazwa
pdfPreviewstatus
 pdfPreviewstatus string

pdfPreviewstatus
previewPageCount
 previewPageCount integer

previewPageCount
previewstatus
 previewstatus string

previewstatus
stan
 status string

stan
typ
 type string

typ
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string

UUID (Uniwersalnie Unikalny Identyfikator)
wopiRestricted
 wopiRestricted boolean

wopiRestricted

Wyświetlanie listy obszarów roboczych

Identyfikator operacji:
ListWorkspaces

Pobierz listę udziałów, które użytkownik żądający ma uprawnienia do wyświetlenia

Parametry

Nazwa Klucz Wymagane Typ Opis
Długość
 length integer

Maksymalna liczba wyników do pobrania
Przesunięcie
 offset integer

Wynik, na którym zaczynają się zwracane wartości (domyślnie to 0)
Właściciel
 ownerUuid string

Identyfikator UUID użytkownika właściciela. Jeśli pod warunkiem, że wyniki będą ograniczone do udziałów należących do tego użytkownika
Uczestnik
 participantUuid string

Identyfikator UUID użytkownika uczestnika. Jeśli pod warunkiem, że wyniki zostaną ograniczone do udziałów, w których ten użytkownik jest uczestnikiem
Query
 query string

Ciąg zapytania wyszukiwania. Jeśli pod warunkiem, że wyniki będą ograniczone do udziałów o nazwie zawierającej daną wartość zapytania
Sortuj
 sort string

Ciąg kryteriów sortowania. Dopuszczalne wartości to

  • nazwa
  • data utworzenia
  • modifiedDate
  • Połączone
  • shareOrder
  • organizacja Kryteria sortowania można opcjonalnie przestrzegać ":d esc", aby wskazać, że sortowanie powinno być w kolejności malejącej. Jeśli nie podano informacji o sortowaniu lub zawiera nieprawidłowe wartości, lista zostanie posortowana według rosnącej nazwy udziału.
Grupa robocza
 workgroupUuid string

Identyfikator UUID grupy roboczej. Jeśli pod warunkiem, że wyniki będą ograniczone do udziałów należących do grupy roboczej

Zwraca

response
array of ShareResponse

Wyświetlanie listy wersji dokumentów

Identyfikator operacji:
ListDocumentVersions

Pobieranie listy wersji zasobów

Parametry

Nazwa Klucz Wymagane Typ Opis
Dokument
 assetUuid True string

Identyfikator UUID dokumentu
Workspace
 shareUuid True string

Identyfikator UUID obszaru roboczego
Długość
 length integer

Maksymalna liczba wyników do pobrania
Przesunięcie
 offset integer

Wynik, na którym ma być uruchomiony (wartość domyślna to 0).

Zwraca

response
array of DocumentVersion

Definicje

Access

Access
string

AssetReturnDocumentResponse

Nazwa Ścieżka Typ Opis
commentCount
 commentCount integer
wersja zawartości
 contentVersion integer
data utworzenia
 createdDate string
rozszerzenie
 extension string
rozmiar pliku
 fileSize integer
zablokowany
 locked boolean
model
 model string
modifiedByUuid
 modifiedByUuid string
modifiedDate
 modifiedDate string
nazwa
 name string
parentUuid
 parentUuid string
previewPageCount
 previewPageCount integer
previewstatus
 previewstatus PreviewStatus
stan
 status AssetStatus
podsumowanie
 summary string
typ
 type AssetType
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string
wopiRestricted
 wopiRestricted boolean

AssetStatus

string

AssetType

string

DocumentVersion

Nazwa Ścieżka Typ Opis
data utworzenia
 createdDate string
rozszerzenie
 extension string
rozmiar pliku
 fileSize integer
model
 model string
stan
 status AssetStatus
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string
wersja
 version integer

EndOnDateOptionalValue

Nazwa Ścieżka Typ Opis
prezentować
 present boolean
value
 value string

NotificationPreference

NotificationPreference
string

PreviewStatus

string

ShareResponse

Nazwa Ścieżka Typ Opis
Access
 access Access
connections
 connections integer
data utworzenia
 createdDate string
EndOnDateOptionalValue
 endOnDateOptionalValue EndOnDateOptionalValue
model
 model string
modifiedDate
 modifiedDate string
nazwa
 name string
organizationUuid
 organisationUuid string
ownerUuid
 ownerUuid string
zabezpieczyć
 secure boolean
ShareStatus
 shareStatus ShareStatus
stan
 status AssetStatus
SynchStatus
 synchStatus SynchStatus
UUID (Uniwersalnie Unikalny Identyfikator)
 uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

UserResponse

Nazwa Ścieżka Typ Opis
wygaszony
 disabled boolean
e-mail
 email string
imię
 firstName string
hideEmailAddress
 hideEmailAddress boolean
nazwisko
 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 (Uniwersalnie Unikalny Identyfikator)
 uuid string

UserStatus

UserStatus
string