Dela via

Objective Connect (förhandsversion)

Objective Connect är den betrodda fildelningsplattformen som gör det möjligt för organisationen att dela känsliga dokument med externa parter. Användare kan skapa privata arbetsytor och bjuda in deltagare i molnet på några sekunder. Funktionerna för samarbete, rapportering, säkerhet och efterlevnad gör det möjligt för regeringar och reglerade branscher att arbeta externt samtidigt som de har sinnesfrid.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Metadata för anslutningsprogram
Utgivare Objective Corporation

Skapa en anslutning

Anslutningsappen stöder följande autentiseringstyper:
Standardinställning Parametrar för att skapa anslutning. Alla regioner Går inte att dela

Standard

Tillämpligt: Alla regioner

Parametrar för att skapa anslutning.

Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.

Namn Typ Description Krävs
Lösenord securestring Lösenordet för det här API:et Sann
Serverregion. (Storbritannien - secure.objectiveconnect.co.uk, ANZ - secure.objectiveconnect.com) snöre Ange Objective Connect-server. Sann
Användarnamn securestring Användarnamnet för det här API:et Sann

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Hämta användare

Hämta användare
Hämta arbetsyta

Hämta arbetsyta efter ID
Hämta deltagare

Hämta arbetsytedeltagare
Hämta dokumentinnehåll

Returnerar innehållet i ett dokument
Hämta dokumentversion

Hämta en tillgångsversion
Hämta dokumentversionsinnehåll

Returnerar innehållet i en dokumentversion
Ladda upp dokumentinnehåll

Ladda upp innehåll för ett dokument
Lista dokumentversioner

Hämta en lista över tillgångsversioner
Lägga till eller uppdatera deltagare

Bjud in ny deltagare eller redigera tilldelade roller
Skapa arbetsyta

Skapa arbetsyta
Skapa dokument

Om Begäran är application:hal+json skapas endast metadata. Om Begäran är multipart:form-data skapas dokumentet med innehåll i ett enda anrop.
Ta bort deltagare

Tar bort deltagare från arbetsytan
Visa en lista över arbetsytor

Hämta en lista över resurser som den begärande användaren har behörighet att se
Visa en lista över delade dokument

Hämta en lista över tillgångar efter arbetsytans UUID

Hämta användare

Åtgärds-ID:
GetUser

Hämta användare

Parametrar

Name Nyckel Obligatorisk Typ Description
E-postmeddelande
 emailAddress string

E-postadressen att söka efter
Length
 length integer

Antalet resultat som ska returneras. Används endast om förskjutningen används.
Offset
 offset integer

Returnera resultatet efter den här positionen
Organisation
 orgUuid string

UUID för organisationen att söka efter
Sortera
 sort string

Param - sort bör vara av formatet ett ord som anger sorteringsfältet en valfri tagg för ":d esc", om den inte finns stigande antas. Felaktiga eller tomma begäranden är som standard stigande namn. Tillgängliga sorteringar är – firstName, lastName, e-post
Användar-UUID:er
 uuids array

Listan över användar-uuids

Returer

response
array of UserResponse

Hämta arbetsyta

Åtgärds-ID:
GetWorkspace

Hämta arbetsyta efter ID

Parametrar

Name Nyckel Obligatorisk Typ Description
Workspace
 shareUuid True string

Uuid för arbetsytan som ska hämtas

Returer

Body
ShareResponse

Hämta deltagare

Åtgärds-ID:
GetParticipants

Hämta arbetsytedeltagare

Parametrar

Name Nyckel Obligatorisk Typ Description
User
 userUuid string

Användar-UUID

Returer

Name Sökväg Typ Description
array of object
har godkänts
 accepted boolean

har godkänts
Mejladress
 email string

Mejladress
isOwner
 isOwner boolean

isOwner
joinedDate
 joinedDate string

joinedDate
model
 model string

model
name
 name string

name
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
type
 type string

type
Universellt unik identifierare (UUID)
 uuid string

Universellt unik identifierare (UUID)

Hämta dokumentinnehåll

Åtgärds-ID:
GetDocumentContent

Returnerar innehållet i ett dokument

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument
 assetUuid True string

universellt unik identifierare (UUID)
Workspace
 shareUuid True string

universellt unik identifierare (UUID)

Hämta dokumentversion

Åtgärds-ID:
GetDocumentVersion

Hämta en tillgångsversion

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument
 assetUuid True string

universellt unik identifierare (UUID)
Workspace
 shareUuid True string

universellt unik identifierare (UUID)
Utgåva
 version True integer

Versionsnumret för dokumentet

Returer

Body
DocumentVersion

Hämta dokumentversionsinnehåll

Åtgärds-ID:
GetDocumentVersionContent

Returnerar innehållet i en dokumentversion

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument
 assetUuid True string

universellt unik identifierare (UUID)
Innehållsversion
 contentVersion True integer

Versionsnumret för dokumentet
Workspace
 shareUuid True string

universellt unik identifierare (UUID)

Ladda upp dokumentinnehåll

Åtgärds-ID:
UploadDocumentContent

Ladda upp innehåll för ett dokument

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument
 assetUuid True string

Dokument-UUID
Workspace
 shareUuid True string

UUID för arbetsyta
Filinnehåll
 file True file

Filinnehållet som ska laddas upp

Lista dokumentversioner

Åtgärds-ID:
ListDocumentVersions

Hämta en lista över tillgångsversioner

Parametrar

Name Nyckel Obligatorisk Typ Description
Dokument
 assetUuid True string

Dokument-UUID
Workspace
 shareUuid True string

UUID för arbetsyta
Length
 length integer

Det maximala antalet resultat som ska hämtas
Offset
 offset integer

Resultatet som ska startas (standardvärdet är 0).

Returer

response
array of DocumentVersion

Lägga till eller uppdatera deltagare

Åtgärds-ID:
AddParticipant

Bjud in ny deltagare eller redigera tilldelade roller

Parametrar

Name Nyckel Obligatorisk Typ Description
e-postmeddelanden
 emails True array of string

e-postmeddelanden
Message
 message string

Inbjudningsmeddelande
roles
 roles array of string

roles
UUID för arbetsyta
 shareUuid True string

universellt unik identifierare (UUID)
Deltagarnas synlighet
 type string

STANDARD – synlig för andra deltagare. Hemlig kopia – deltagaren kommer att döljas för andra

Returer

Name Sökväg Typ Description
array of object
har godkänts
 accepted boolean

har godkänts
Mejladress
 email string

Mejladress
isOwner
 isOwner boolean

isOwner
model
 model string

model
roles
 roles array of string

roles
shareUuid
 shareUuid string

shareUuid
type
 type string

type
Universellt unik identifierare (UUID)
 uuid string

Universellt unik identifierare (UUID)

Skapa arbetsyta

Åtgärds-ID:
CreateWorkspace

Skapa arbetsyta

Parametrar

Name Nyckel Obligatorisk Typ Description
Användar-UUID
 userUuid True string

Användar-UUID
Åtkomst
 access string
Handläggare
 agentShareToken string

Agenttoken
Namn
 name True string

Namn
Organization
 organisationUuid string

Organisations-UUID
Ägare
 ownerUuid string

Ägar-UUID
Sammanfattning
 summary string

Sammanfattning
universellt unik identifierare (UUID)
 uuid string

universellt unik identifierare (UUID)

Returer

Body
ShareResponse

Skapa dokument

Åtgärds-ID:
CreateDocument

Om Begäran är application:hal+json skapas endast metadata. Om Begäran är multipart:form-data skapas dokumentet med innehåll i ett enda anrop.

Parametrar

Name Nyckel Obligatorisk Typ Description
UUID för arbetsyta
 shareUuid True string

Dela uuid från sökvägen
Filinnehåll
 file True file

Filinnehållet som ska laddas upp
Filnamn
 name True string

Filnamnet
Överordnat UUID
 parentUuid string

(Valfritt)
Sammanfattning
 summary string

(Valfritt)

Returer

Body
AssetReturnDocumentResponse

Ta bort deltagare

Åtgärds-ID:
DeleteParticipant

Tar bort deltagare från arbetsytan

Parametrar

Name Nyckel Obligatorisk Typ Description
User
 uuid True string

Användar-UUID

Visa en lista över arbetsytor

Åtgärds-ID:
ListWorkspaces

Hämta en lista över resurser som den begärande användaren har behörighet att se

Parametrar

Name Nyckel Obligatorisk Typ Description
Length
 length integer

Maximalt antal resultat att hämta
Offset
 offset integer

Resultat där returnerade värden startar (standardvärdet är 0)
Ägare
 ownerUuid string

Användarens UUID för ägaren. Om det tillhandahålls begränsas resultatet till resurser som ägs av den här användaren
Deltagare
 participantUuid string

Användarens UUID för deltagaren. Om det tillhandahålls begränsas resultatet till resurser där den här användaren är deltagare
Query
 query string

Sök frågesträng. Om det anges begränsas resultatet till resurser med namn som innehåller det angivna frågevärdet
Sortera
 sort string

Sträng för sorteringsordningsvillkor. Godtagbara värden är

  • name
  • skapadDatum
  • modifiedDate
  • förenad
  • shareOrder
  • organisation Sorteringskriterierna kan eventuellt följas av ":d esc" för att indikera att sortering ska vara i fallande ordning. Om ingen sortInfo anges, eller om den innehåller ogiltiga värden, sorteras listan efter stigande Resursnamn.
Arbetsgrupp
 workgroupUuid string

Arbetsgrupps-UUID. Om det tillhandahålls begränsas resultatet till resurser som tillhör arbetsgruppen

Returer

response
array of ShareResponse

Visa en lista över delade dokument

Åtgärds-ID:
ListDocuments

Hämta en lista över tillgångar efter arbetsytans UUID

Parametrar

Name Nyckel Obligatorisk Typ Description
Workspace
 shareUuid True string

UUID för arbetsyta
Length
 length integer

Maximalt antal resultat att hämta
Offset
 offset integer

Resultat där returnerade värden startar (standardvärdet är 0)
Överordnat UUID
 parentUuid string

UUID för resursen eller den överordnade tillgången. Om det tillhandahålls begränsas resultatet till omedelbart underordnade av resursen eller tillgången. Om svaret är ogiltigt blir det 200 med en tom lista.
Query
 query string

Sökfrågesträngen. Om det tillhandahålls begränsas resultatet till tillgångar med namn som börjar med det angivna frågevärdet.
Sortera
 sort string

Sträng för sorteringsordningsvillkor. Godtagbara värden är

  • name
  • skapadDatum
  • modifiedDate
  • storlek Sorteringsvillkoren kan eventuellt följas av ":d esc" för att indikera att sortering ska vara i fallande ordning. Om ingen sortInfo anges, eller om den innehåller ogiltiga värden, sorteras listan efter stigande tillgångsnamn

Returer

Name Sökväg Typ Description
array of object
annotationsCount
 annotationsCount integer

annotationsCount
commentCount
 commentCount integer

commentCount
innehållsversion
 contentVersion integer

innehållsversion
skapadDatum
 createdDate string

skapadDatum
utbyggnad
 extension string

utbyggnad
fileSize (filstorlek)
 fileSize integer

fileSize (filstorlek)
låst
 locked boolean

låst
model
 model string

model
modifiedByUuid
 modifiedByUuid string

modifiedByUuid
modifiedDate
 modifiedDate string

modifiedDate
name
 name string

name
pdfFörhandsstatus
 pdfPreviewstatus string

pdfFörhandsstatus
previewPageCount
 previewPageCount integer

previewPageCount
previewstatus
 previewstatus string

previewstatus
status
 status string

status
type
 type string

type
Universellt unik identifierare (UUID)
 uuid string

Universellt unik identifierare (UUID)
wopiRestricted
 wopiRestricted boolean

wopiRestricted

Definitioner

Åtkomst

Åtkomst
string

AssetReturnDocumentResponse

Name Sökväg Typ Description
commentCount
 commentCount integer
innehållsversion
 contentVersion integer
skapadDatum
 createdDate string
utbyggnad
 extension string
fileSize (filstorlek)
 fileSize integer
låst
 locked boolean
model
 model string
modifiedByUuid
 modifiedByUuid string
modifiedDate
 modifiedDate string
name
 name string
parentUuid
 parentUuid string
previewPageCount
 previewPageCount integer
previewstatus
 previewstatus PreviewStatus
status
 status AssetStatus
summary
 summary string
type
 type AssetType
Universellt unik identifierare (UUID)
 uuid string
wopiRestricted
 wopiRestricted boolean

AssetStatus

string

AssetType

string

DocumentVersion

Name Sökväg Typ Description
skapadDatum
 createdDate string
utbyggnad
 extension string
fileSize (filstorlek)
 fileSize integer
model
 model string
status
 status AssetStatus
Universellt unik identifierare (UUID)
 uuid string
version
 version integer

EndOnDateOptionalValue

Name Sökväg Typ Description
gåva
 present boolean
värde
 value string

NotificationPreference

NotificationPreference
string

PreviewStatus

string

ShareResponse

Name Sökväg Typ Description
Åtkomst
 access Access
connections
 connections integer
skapadDatum
 createdDate string
EndOnDateOptionalValue
 endOnDateOptionalValue EndOnDateOptionalValue
model
 model string
modifiedDate
 modifiedDate string
name
 name string
organisationUuid
 organisationUuid string
ownerUuid
 ownerUuid string
säker
 secure boolean
ShareStatus
 shareStatus ShareStatus
status
 status AssetStatus
SynchStatus
 synchStatus SynchStatus
Universellt unik identifierare (UUID)
 uuid string

ShareStatus

ShareStatus
string

SynchStatus

SynchStatus
string

UserResponse

Name Sökväg Typ Description
funktionshindrad
 disabled boolean
Mejladress
 email string
förnamn
 firstName string
hideEmailAddress
 hideEmailAddress boolean
efternamn
 lastName string
model
 model string
notificationPreferences
 notificationPreferences array of NotificationPreference
organisationUuid
 organisationUuid string
roles
 roles array of string
UserStatus
 status UserStatus
timezone
 timezone string
Universellt unik identifierare (UUID)
 uuid string

UserStatus

UserStatus
string